@llmpulse/sdk 0.0.0-stage → 1.60.0

package/src/apis/MetricsApi.ts

@@ -0,0 +1,1236 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.60.0
+ * Contact: info@llmpulse.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type ApiError,
+    ApiErrorFromJSON,
+    ApiErrorToJSON,
+} from '../models/ApiError';
+import {
+    type PromptSummaryResponse,
+    PromptSummaryResponseFromJSON,
+    PromptSummaryResponseToJSON,
+} from '../models/PromptSummaryResponse';
+import {
+    type SovResponse,
+    SovResponseFromJSON,
+    SovResponseToJSON,
+} from '../models/SovResponse';
+import {
+    type SummaryResponse,
+    SummaryResponseFromJSON,
+    SummaryResponseToJSON,
+} from '../models/SummaryResponse';
+import {
+    type TimeseriesResponse,
+    TimeseriesResponseFromJSON,
+    TimeseriesResponseToJSON,
+} from '../models/TimeseriesResponse';
+import {
+    type TopSourcesResponse,
+    TopSourcesResponseFromJSON,
+    TopSourcesResponseToJSON,
+} from '../models/TopSourcesResponse';
+
+export interface GetPromptSummaryRequest {
+    projectId: number;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    breakdown?: GetPromptSummaryBreakdownEnum;
+    model?: GetPromptSummaryModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    promptType?: string;
+    brandKind?: GetPromptSummaryBrandKindEnum;
+    sort?: GetPromptSummarySortEnum;
+    sortDir?: GetPromptSummarySortDirEnum;
+    page?: number;
+    perPage?: number;
+    output?: GetPromptSummaryOutputEnum;
+}
+
+export interface GetShareOfVoiceRequest {
+    projectId: number;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    granularity?: GetShareOfVoiceGranularityEnum;
+    competitors?: string;
+    model?: GetShareOfVoiceModelEnum;
+    collectionId?: string;
+    prompt?: number;
+    promptType?: string;
+    brandKind?: GetShareOfVoiceBrandKindEnum;
+    output?: GetShareOfVoiceOutputEnum;
+    view?: GetShareOfVoiceViewEnum;
+}
+
+export interface GetSummaryRequest {
+    projectId: number;
+    metrics?: string;
+    granularity?: GetSummaryGranularityEnum;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    competitors?: string;
+    model?: GetSummaryModelEnum;
+    collectionId?: string;
+    prompt?: number;
+    promptType?: string;
+    brandKind?: GetSummaryBrandKindEnum;
+    output?: GetSummaryOutputEnum;
+}
+
+export interface GetTimeseriesRequest {
+    projectId: number;
+    metrics?: string;
+    granularity?: GetTimeseriesGranularityEnum;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    competitors?: string;
+    model?: GetTimeseriesModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    promptType?: string;
+    brandKind?: GetTimeseriesBrandKindEnum;
+    includeProject?: boolean;
+    output?: GetTimeseriesOutputEnum;
+}
+
+export interface GetTopSourcesRequest {
+    projectId: number;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    model?: GetTopSourcesModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    promptType?: string;
+    brandKind?: GetTopSourcesBrandKindEnum;
+    sort?: GetTopSourcesSortEnum;
+    query?: string;
+    page?: number;
+    perPage?: number;
+    output?: GetTopSourcesOutputEnum;
+}
+
+/**
+ * MetricsApi - interface
+ * 
+ * @export
+ * @interface MetricsApiInterface
+ */
+export interface MetricsApiInterface {
+    /**
+     * Creates request options for getPromptSummary without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from] 
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @param {'model'} [breakdown] Add per-(prompt, model) rows to the output
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\'s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message. The legacy values google-ai-mode and google-ai-overview are also accepted, as ai_mode and ai_overview.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {'responses' | 'mentions' | 'citations' | 'mention_rate' | 'visibility' | 'citation_rate' | 'avg_mention_position' | 'avg_position'} [sort] 
+     * @param {'asc' | 'desc'} [sortDir] 
+     * @param {number} [page] 
+     * @param {number} [perPage] 
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof MetricsApiInterface
+     */
+    getPromptSummaryRequestOpts(requestParameters: GetPromptSummaryRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Paginated per-prompt aggregated metrics. Returns responses, mentions, citations, mention_rate, citation_rate, avg_mention_position and avg_position per prompt, plus the brand sentiment of its responses (sentiment_responses, the five sentiment percentages and net_sentiment, computed like the sentiment timeseries) and the prompt\'s classification (country_code, language_code, prompt_type, brand_kind and tags, as in /dimensions/prompts). Citations and citation rate include visible citations and background source references; avg_position uses visible citations only. Pass `breakdown=model` to split each prompt by model.
+     * @summary Per-prompt metrics summary
+     * @param {number} projectId Project ID
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from] 
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @param {'model'} [breakdown] Add per-(prompt, model) rows to the output
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message. The legacy values google-ai-mode and google-ai-overview are also accepted, as ai_mode and ai_overview.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {'responses' | 'mentions' | 'citations' | 'mention_rate' | 'visibility' | 'citation_rate' | 'avg_mention_position' | 'avg_position'} [sort] 
+     * @param {'asc' | 'desc'} [sortDir] 
+     * @param {number} [page] 
+     * @param {number} [perPage] 
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricsApiInterface
+     */
+    getPromptSummaryRaw(requestParameters: GetPromptSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PromptSummaryResponse>>;
+
+    /**
+     * Paginated per-prompt aggregated metrics. Returns responses, mentions, citations, mention_rate, citation_rate, avg_mention_position and avg_position per prompt, plus the brand sentiment of its responses (sentiment_responses, the five sentiment percentages and net_sentiment, computed like the sentiment timeseries) and the prompt\'s classification (country_code, language_code, prompt_type, brand_kind and tags, as in /dimensions/prompts). Citations and citation rate include visible citations and background source references; avg_position uses visible citations only. Pass `breakdown=model` to split each prompt by model.
+     * Per-prompt metrics summary
+     */
+    getPromptSummary(requestParameters: GetPromptSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptSummaryResponse>;
+
+    /**
+     * Creates request options for getShareOfVoice without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from] 
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @param {'day' | 'week' | 'month'} [granularity] 
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message. The legacy values google-ai-mode and google-ai-overview are also accepted, as ai_mode and ai_overview.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {'over_time' | 'current' | 'breakdown'} [view] Which Share of Voice projection to flatten. Only valid together with \&#39;output\&#39;. \&#39;over_time\&#39; (default) is one row per date and actor, \&#39;current\&#39; the ranked snapshot, \&#39;breakdown\&#39; the Top 4 plus Others.
+     * @throws {RequiredError}
+     * @memberof MetricsApiInterface
+     */
+    getShareOfVoiceRequestOpts(requestParameters: GetShareOfVoiceRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Share of Voice breakdown comparing your project to competitors. Returns over_time, current snapshot, and a Top-4 + Others breakdown.
+     * @summary Share of Voice
+     * @param {number} projectId Project ID
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from] 
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @param {'day' | 'week' | 'month'} [granularity] 
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message. The legacy values google-ai-mode and google-ai-overview are also accepted, as ai_mode and ai_overview.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {'over_time' | 'current' | 'breakdown'} [view] Which Share of Voice projection to flatten. Only valid together with \&#39;output\&#39;. \&#39;over_time\&#39; (default) is one row per date and actor, \&#39;current\&#39; the ranked snapshot, \&#39;breakdown\&#39; the Top 4 plus Others.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricsApiInterface
+     */
+    getShareOfVoiceRaw(requestParameters: GetShareOfVoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SovResponse>>;
+
+    /**
+     * Share of Voice breakdown comparing your project to competitors. Returns over_time, current snapshot, and a Top-4 + Others breakdown.
+     * Share of Voice
+     */
+    getShareOfVoice(requestParameters: GetShareOfVoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SovResponse>;
+
+    /**
+     * Creates request options for getSummary without sending the request
+     * @param {number} projectId Project ID
+     * @param {string} [metrics] Comma-separated list of metrics: mentions, citations, responses, mention_rate, visibility (alias for mention_rate), weighted_visibility, ai_visibility_score (alias for weighted_visibility), citation_rate, avg_position, avg_mention_position, net_sentiment, sentiment_very_positive, sentiment_positive, sentiment_neutral, sentiment_negative, sentiment_very_negative. Citations and citation_rate include visible citations and background source references; avg_position uses visible citations only.
+     * @param {'day' | 'week' | 'month'} [granularity] 
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from] 
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message. The legacy values google-ai-mode and google-ai-overview are also accepted, as ai_mode and ai_overview.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof MetricsApiInterface
+     */
+    getSummaryRequestOpts(requestParameters: GetSummaryRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Same as /metrics/timeseries but adds a `summary` block with total/min/max/last per metric per actor, plus a `position_distribution` block (Position 1, Position 2, Position 3+). Citations and citation rate include visible citations and background source references. Background references use position 0 and are excluded from avg_position and position distributions. `total` is a SUM for count metrics (mentions, citations, responses) and an AVERAGE across periods for rate/percentage and average metrics (visibility/mention_rate, citation_rate, ai_visibility_score, sentiment shares, avg_position, avg_mention_position, net_sentiment); rates are never summed. Each summary row carries an `aggregation` field (`sum` or `average`).
+     * @summary Aggregated metrics summary
+     * @param {number} projectId Project ID
+     * @param {string} [metrics] Comma-separated list of metrics: mentions, citations, responses, mention_rate, visibility (alias for mention_rate), weighted_visibility, ai_visibility_score (alias for weighted_visibility), citation_rate, avg_position, avg_mention_position, net_sentiment, sentiment_very_positive, sentiment_positive, sentiment_neutral, sentiment_negative, sentiment_very_negative. Citations and citation_rate include visible citations and background source references; avg_position uses visible citations only.
+     * @param {'day' | 'week' | 'month'} [granularity] 
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from] 
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message. The legacy values google-ai-mode and google-ai-overview are also accepted, as ai_mode and ai_overview.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricsApiInterface
+     */
+    getSummaryRaw(requestParameters: GetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SummaryResponse>>;
+
+    /**
+     * Same as /metrics/timeseries but adds a `summary` block with total/min/max/last per metric per actor, plus a `position_distribution` block (Position 1, Position 2, Position 3+). Citations and citation rate include visible citations and background source references. Background references use position 0 and are excluded from avg_position and position distributions. `total` is a SUM for count metrics (mentions, citations, responses) and an AVERAGE across periods for rate/percentage and average metrics (visibility/mention_rate, citation_rate, ai_visibility_score, sentiment shares, avg_position, avg_mention_position, net_sentiment); rates are never summed. Each summary row carries an `aggregation` field (`sum` or `average`).
+     * Aggregated metrics summary
+     */
+    getSummary(requestParameters: GetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SummaryResponse>;
+
+    /**
+     * Creates request options for getTimeseries without sending the request
+     * @param {number} projectId Project ID
+     * @param {string} [metrics] Comma-separated list of metrics: mentions, citations, responses, mention_rate, visibility (alias for mention_rate), weighted_visibility, ai_visibility_score (alias for weighted_visibility), citation_rate, avg_position, avg_mention_position, net_sentiment, sentiment_very_positive, sentiment_positive, sentiment_neutral, sentiment_negative, sentiment_very_negative. Citations and citation_rate include visible citations and background source references; avg_position uses visible citations only.
+     * @param {'day' | 'week' | 'month'} [granularity] 
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from] 
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message. The legacy values google-ai-mode and google-ai-overview are also accepted, as ai_mode and ai_overview.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {boolean} [includeProject] 
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof MetricsApiInterface
+     */
+    getTimeseriesRequestOpts(requestParameters: GetTimeseriesRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Returns time-series data for one or more metrics, broken down by actor (project + competitors). Supports day/week/month granularity, with sticky carry-forward semantics for week/month aggregates.
+     * @summary Time-series metrics
+     * @param {number} projectId Project ID
+     * @param {string} [metrics] Comma-separated list of metrics: mentions, citations, responses, mention_rate, visibility (alias for mention_rate), weighted_visibility, ai_visibility_score (alias for weighted_visibility), citation_rate, avg_position, avg_mention_position, net_sentiment, sentiment_very_positive, sentiment_positive, sentiment_neutral, sentiment_negative, sentiment_very_negative. Citations and citation_rate include visible citations and background source references; avg_position uses visible citations only.
+     * @param {'day' | 'week' | 'month'} [granularity] 
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from] 
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message. The legacy values google-ai-mode and google-ai-overview are also accepted, as ai_mode and ai_overview.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {boolean} [includeProject] 
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricsApiInterface
+     */
+    getTimeseriesRaw(requestParameters: GetTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TimeseriesResponse>>;
+
+    /**
+     * Returns time-series data for one or more metrics, broken down by actor (project + competitors). Supports day/week/month granularity, with sticky carry-forward semantics for week/month aggregates.
+     * Time-series metrics
+     */
+    getTimeseries(requestParameters: GetTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TimeseriesResponse>;
+
+    /**
+     * Creates request options for getTopSources without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from] 
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message. The legacy values google-ai-mode and google-ai-overview are also accepted, as ai_mode and ai_overview.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {'total_responses' | 'avg_mention_rate' | 'avg_visibility'} [sort] 
+     * @param {string} [query] Filter domains by case-insensitive partial match
+     * @param {number} [page] 
+     * @param {number} [perPage] 
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @throws {RequiredError}
+     * @memberof MetricsApiInterface
+     */
+    getTopSourcesRequestOpts(requestParameters: GetTopSourcesRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Registrable domains most frequently cited in AI responses for the project, including visible citations and background source references. This endpoint remains a domain rollup when exact-subdomain matching is enabled. Results can be sorted by total responses, average mention rate, or average visibility.
+     * @summary Top cited sources
+     * @param {number} projectId Project ID
+     * @param {number} [range] Number of days to look back (alternative to from/to)
+     * @param {Date} [from] 
+     * @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
+     * @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by one AI model. It must be a model enabled for the API key\&#39;s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message. The legacy values google-ai-mode and google-ai-overview are also accepted, as ai_mode and ai_overview.
+     * @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
+     * @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
+     * @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
+     * @param {number} [prompt] Filter by prompt ID
+     * @param {string} [promptType] One prompt type or a comma-separated list: informational, navigational, commercial, transactional
+     * @param {'brand' | 'brand_other' | 'non_brand'} [brandKind] Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.
+     * @param {'total_responses' | 'avg_mention_rate' | 'avg_visibility'} [sort] 
+     * @param {string} [query] Filter domains by case-insensitive partial match
+     * @param {number} [page] 
+     * @param {number} [perPage] 
+     * @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \&#39;flat\&#39; returns the same metadata plus \&#39;columns\&#39; and \&#39;rows\&#39;; \&#39;csv\&#39; returns those rows as text/csv. Errors are always returned as JSON.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MetricsApiInterface
+     */
+    getTopSourcesRaw(requestParameters: GetTopSourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TopSourcesResponse>>;
+
+    /**
+     * Registrable domains most frequently cited in AI responses for the project, including visible citations and background source references. This endpoint remains a domain rollup when exact-subdomain matching is enabled. Results can be sorted by total responses, average mention rate, or average visibility.
+     * Top cited sources
+     */
+    getTopSources(requestParameters: GetTopSourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TopSourcesResponse>;
+
+}
+
+/**
+ * 
+ */
+export class MetricsApi extends runtime.BaseAPI implements MetricsApiInterface {
+
+    /**
+     * Creates request options for getPromptSummary without sending the request
+     */
+    async getPromptSummaryRequestOpts(requestParameters: GetPromptSummaryRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling getPromptSummary().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        if (requestParameters['range'] != null) {
+            queryParameters['range'] = requestParameters['range'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString();
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString();
+        }
+
+        if (requestParameters['breakdown'] != null) {
+            queryParameters['breakdown'] = requestParameters['breakdown'];
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['collectionId'] != null) {
+            queryParameters['collection_id'] = requestParameters['collectionId'];
+        }
+
+        if (requestParameters['countryCode'] != null) {
+            queryParameters['country_code'] = requestParameters['countryCode'];
+        }
+
+        if (requestParameters['languageCode'] != null) {
+            queryParameters['language_code'] = requestParameters['languageCode'];
+        }
+
+        if (requestParameters['prompt'] != null) {
+            queryParameters['prompt'] = requestParameters['prompt'];
+        }
+
+        if (requestParameters['promptType'] != null) {
+            queryParameters['prompt_type'] = requestParameters['promptType'];
+        }
+
+        if (requestParameters['brandKind'] != null) {
+            queryParameters['brand_kind'] = requestParameters['brandKind'];
+        }
+
+        if (requestParameters['sort'] != null) {
+            queryParameters['sort'] = requestParameters['sort'];
+        }
+
+        if (requestParameters['sortDir'] != null) {
+            queryParameters['sort_dir'] = requestParameters['sortDir'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        if (requestParameters['output'] != null) {
+            queryParameters['output'] = requestParameters['output'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/metrics/prompt_summary`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Paginated per-prompt aggregated metrics. Returns responses, mentions, citations, mention_rate, citation_rate, avg_mention_position and avg_position per prompt, plus the brand sentiment of its responses (sentiment_responses, the five sentiment percentages and net_sentiment, computed like the sentiment timeseries) and the prompt\'s classification (country_code, language_code, prompt_type, brand_kind and tags, as in /dimensions/prompts). Citations and citation rate include visible citations and background source references; avg_position uses visible citations only. Pass `breakdown=model` to split each prompt by model.
+     * Per-prompt metrics summary
+     */
+    async getPromptSummaryRaw(requestParameters: GetPromptSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PromptSummaryResponse>> {
+        const requestOptions = await this.getPromptSummaryRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PromptSummaryResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Paginated per-prompt aggregated metrics. Returns responses, mentions, citations, mention_rate, citation_rate, avg_mention_position and avg_position per prompt, plus the brand sentiment of its responses (sentiment_responses, the five sentiment percentages and net_sentiment, computed like the sentiment timeseries) and the prompt\'s classification (country_code, language_code, prompt_type, brand_kind and tags, as in /dimensions/prompts). Citations and citation rate include visible citations and background source references; avg_position uses visible citations only. Pass `breakdown=model` to split each prompt by model.
+     * Per-prompt metrics summary
+     */
+    async getPromptSummary(requestParameters: GetPromptSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PromptSummaryResponse> {
+        const response = await this.getPromptSummaryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getShareOfVoice without sending the request
+     */
+    async getShareOfVoiceRequestOpts(requestParameters: GetShareOfVoiceRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling getShareOfVoice().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        if (requestParameters['range'] != null) {
+            queryParameters['range'] = requestParameters['range'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString();
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString();
+        }
+
+        if (requestParameters['granularity'] != null) {
+            queryParameters['granularity'] = requestParameters['granularity'];
+        }
+
+        if (requestParameters['competitors'] != null) {
+            queryParameters['competitors'] = requestParameters['competitors'];
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['collectionId'] != null) {
+            queryParameters['collection_id'] = requestParameters['collectionId'];
+        }
+
+        if (requestParameters['prompt'] != null) {
+            queryParameters['prompt'] = requestParameters['prompt'];
+        }
+
+        if (requestParameters['promptType'] != null) {
+            queryParameters['prompt_type'] = requestParameters['promptType'];
+        }
+
+        if (requestParameters['brandKind'] != null) {
+            queryParameters['brand_kind'] = requestParameters['brandKind'];
+        }
+
+        if (requestParameters['output'] != null) {
+            queryParameters['output'] = requestParameters['output'];
+        }
+
+        if (requestParameters['view'] != null) {
+            queryParameters['view'] = requestParameters['view'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/metrics/sov`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Share of Voice breakdown comparing your project to competitors. Returns over_time, current snapshot, and a Top-4 + Others breakdown.
+     * Share of Voice
+     */
+    async getShareOfVoiceRaw(requestParameters: GetShareOfVoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SovResponse>> {
+        const requestOptions = await this.getShareOfVoiceRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SovResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Share of Voice breakdown comparing your project to competitors. Returns over_time, current snapshot, and a Top-4 + Others breakdown.
+     * Share of Voice
+     */
+    async getShareOfVoice(requestParameters: GetShareOfVoiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SovResponse> {
+        const response = await this.getShareOfVoiceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getSummary without sending the request
+     */
+    async getSummaryRequestOpts(requestParameters: GetSummaryRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling getSummary().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        if (requestParameters['metrics'] != null) {
+            queryParameters['metrics'] = requestParameters['metrics'];
+        }
+
+        if (requestParameters['granularity'] != null) {
+            queryParameters['granularity'] = requestParameters['granularity'];
+        }
+
+        if (requestParameters['range'] != null) {
+            queryParameters['range'] = requestParameters['range'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString();
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString();
+        }
+
+        if (requestParameters['competitors'] != null) {
+            queryParameters['competitors'] = requestParameters['competitors'];
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['collectionId'] != null) {
+            queryParameters['collection_id'] = requestParameters['collectionId'];
+        }
+
+        if (requestParameters['prompt'] != null) {
+            queryParameters['prompt'] = requestParameters['prompt'];
+        }
+
+        if (requestParameters['promptType'] != null) {
+            queryParameters['prompt_type'] = requestParameters['promptType'];
+        }
+
+        if (requestParameters['brandKind'] != null) {
+            queryParameters['brand_kind'] = requestParameters['brandKind'];
+        }
+
+        if (requestParameters['output'] != null) {
+            queryParameters['output'] = requestParameters['output'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/metrics/summary`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Same as /metrics/timeseries but adds a `summary` block with total/min/max/last per metric per actor, plus a `position_distribution` block (Position 1, Position 2, Position 3+). Citations and citation rate include visible citations and background source references. Background references use position 0 and are excluded from avg_position and position distributions. `total` is a SUM for count metrics (mentions, citations, responses) and an AVERAGE across periods for rate/percentage and average metrics (visibility/mention_rate, citation_rate, ai_visibility_score, sentiment shares, avg_position, avg_mention_position, net_sentiment); rates are never summed. Each summary row carries an `aggregation` field (`sum` or `average`).
+     * Aggregated metrics summary
+     */
+    async getSummaryRaw(requestParameters: GetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SummaryResponse>> {
+        const requestOptions = await this.getSummaryRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SummaryResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Same as /metrics/timeseries but adds a `summary` block with total/min/max/last per metric per actor, plus a `position_distribution` block (Position 1, Position 2, Position 3+). Citations and citation rate include visible citations and background source references. Background references use position 0 and are excluded from avg_position and position distributions. `total` is a SUM for count metrics (mentions, citations, responses) and an AVERAGE across periods for rate/percentage and average metrics (visibility/mention_rate, citation_rate, ai_visibility_score, sentiment shares, avg_position, avg_mention_position, net_sentiment); rates are never summed. Each summary row carries an `aggregation` field (`sum` or `average`).
+     * Aggregated metrics summary
+     */
+    async getSummary(requestParameters: GetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SummaryResponse> {
+        const response = await this.getSummaryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getTimeseries without sending the request
+     */
+    async getTimeseriesRequestOpts(requestParameters: GetTimeseriesRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling getTimeseries().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        if (requestParameters['metrics'] != null) {
+            queryParameters['metrics'] = requestParameters['metrics'];
+        }
+
+        if (requestParameters['granularity'] != null) {
+            queryParameters['granularity'] = requestParameters['granularity'];
+        }
+
+        if (requestParameters['range'] != null) {
+            queryParameters['range'] = requestParameters['range'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString();
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString();
+        }
+
+        if (requestParameters['competitors'] != null) {
+            queryParameters['competitors'] = requestParameters['competitors'];
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['collectionId'] != null) {
+            queryParameters['collection_id'] = requestParameters['collectionId'];
+        }
+
+        if (requestParameters['countryCode'] != null) {
+            queryParameters['country_code'] = requestParameters['countryCode'];
+        }
+
+        if (requestParameters['languageCode'] != null) {
+            queryParameters['language_code'] = requestParameters['languageCode'];
+        }
+
+        if (requestParameters['prompt'] != null) {
+            queryParameters['prompt'] = requestParameters['prompt'];
+        }
+
+        if (requestParameters['promptType'] != null) {
+            queryParameters['prompt_type'] = requestParameters['promptType'];
+        }
+
+        if (requestParameters['brandKind'] != null) {
+            queryParameters['brand_kind'] = requestParameters['brandKind'];
+        }
+
+        if (requestParameters['includeProject'] != null) {
+            queryParameters['include_project'] = requestParameters['includeProject'];
+        }
+
+        if (requestParameters['output'] != null) {
+            queryParameters['output'] = requestParameters['output'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/metrics/timeseries`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns time-series data for one or more metrics, broken down by actor (project + competitors). Supports day/week/month granularity, with sticky carry-forward semantics for week/month aggregates.
+     * Time-series metrics
+     */
+    async getTimeseriesRaw(requestParameters: GetTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TimeseriesResponse>> {
+        const requestOptions = await this.getTimeseriesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TimeseriesResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns time-series data for one or more metrics, broken down by actor (project + competitors). Supports day/week/month granularity, with sticky carry-forward semantics for week/month aggregates.
+     * Time-series metrics
+     */
+    async getTimeseries(requestParameters: GetTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TimeseriesResponse> {
+        const response = await this.getTimeseriesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getTopSources without sending the request
+     */
+    async getTopSourcesRequestOpts(requestParameters: GetTopSourcesRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['projectId'] == null) {
+            throw new runtime.RequiredError(
+                'projectId',
+                'Required parameter "projectId" was null or undefined when calling getTopSources().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['projectId'] != null) {
+            queryParameters['project_id'] = requestParameters['projectId'];
+        }
+
+        if (requestParameters['range'] != null) {
+            queryParameters['range'] = requestParameters['range'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString();
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString();
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['collectionId'] != null) {
+            queryParameters['collection_id'] = requestParameters['collectionId'];
+        }
+
+        if (requestParameters['countryCode'] != null) {
+            queryParameters['country_code'] = requestParameters['countryCode'];
+        }
+
+        if (requestParameters['languageCode'] != null) {
+            queryParameters['language_code'] = requestParameters['languageCode'];
+        }
+
+        if (requestParameters['prompt'] != null) {
+            queryParameters['prompt'] = requestParameters['prompt'];
+        }
+
+        if (requestParameters['promptType'] != null) {
+            queryParameters['prompt_type'] = requestParameters['promptType'];
+        }
+
+        if (requestParameters['brandKind'] != null) {
+            queryParameters['brand_kind'] = requestParameters['brandKind'];
+        }
+
+        if (requestParameters['sort'] != null) {
+            queryParameters['sort'] = requestParameters['sort'];
+        }
+
+        if (requestParameters['query'] != null) {
+            queryParameters['query'] = requestParameters['query'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        if (requestParameters['output'] != null) {
+            queryParameters['output'] = requestParameters['output'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/metrics/top_sources`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Registrable domains most frequently cited in AI responses for the project, including visible citations and background source references. This endpoint remains a domain rollup when exact-subdomain matching is enabled. Results can be sorted by total responses, average mention rate, or average visibility.
+     * Top cited sources
+     */
+    async getTopSourcesRaw(requestParameters: GetTopSourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TopSourcesResponse>> {
+        const requestOptions = await this.getTopSourcesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TopSourcesResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Registrable domains most frequently cited in AI responses for the project, including visible citations and background source references. This endpoint remains a domain rollup when exact-subdomain matching is enabled. Results can be sorted by total responses, average mention rate, or average visibility.
+     * Top cited sources
+     */
+    async getTopSources(requestParameters: GetTopSourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TopSourcesResponse> {
+        const response = await this.getTopSourcesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const GetPromptSummaryBreakdownEnum = {
+    Model: 'model'
+} as const;
+export type GetPromptSummaryBreakdownEnum = typeof GetPromptSummaryBreakdownEnum[keyof typeof GetPromptSummaryBreakdownEnum];
+/**
+ * @export
+ */
+export const GetPromptSummaryModelEnum = {
+    Chatgpt: 'chatgpt',
+    Perplexity: 'perplexity',
+    AiMode: 'ai_mode',
+    AiOverview: 'ai_overview',
+    Gemini: 'gemini',
+    Copilot: 'copilot',
+    AmazonRufus: 'amazon_rufus',
+    Claude: 'claude',
+    Grok: 'grok',
+    Deepseek: 'deepseek',
+    NaverAi: 'naver_ai',
+    BaiduAi: 'baidu_ai',
+    MetaAi: 'meta_ai'
+} as const;
+export type GetPromptSummaryModelEnum = typeof GetPromptSummaryModelEnum[keyof typeof GetPromptSummaryModelEnum];
+/**
+ * @export
+ */
+export const GetPromptSummaryBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+} as const;
+export type GetPromptSummaryBrandKindEnum = typeof GetPromptSummaryBrandKindEnum[keyof typeof GetPromptSummaryBrandKindEnum];
+/**
+ * @export
+ */
+export const GetPromptSummarySortEnum = {
+    Responses: 'responses',
+    Mentions: 'mentions',
+    Citations: 'citations',
+    MentionRate: 'mention_rate',
+    Visibility: 'visibility',
+    CitationRate: 'citation_rate',
+    AvgMentionPosition: 'avg_mention_position',
+    AvgPosition: 'avg_position'
+} as const;
+export type GetPromptSummarySortEnum = typeof GetPromptSummarySortEnum[keyof typeof GetPromptSummarySortEnum];
+/**
+ * @export
+ */
+export const GetPromptSummarySortDirEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type GetPromptSummarySortDirEnum = typeof GetPromptSummarySortDirEnum[keyof typeof GetPromptSummarySortDirEnum];
+/**
+ * @export
+ */
+export const GetPromptSummaryOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+} as const;
+export type GetPromptSummaryOutputEnum = typeof GetPromptSummaryOutputEnum[keyof typeof GetPromptSummaryOutputEnum];
+/**
+ * @export
+ */
+export const GetShareOfVoiceGranularityEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month'
+} as const;
+export type GetShareOfVoiceGranularityEnum = typeof GetShareOfVoiceGranularityEnum[keyof typeof GetShareOfVoiceGranularityEnum];
+/**
+ * @export
+ */
+export const GetShareOfVoiceModelEnum = {
+    Chatgpt: 'chatgpt',
+    Perplexity: 'perplexity',
+    AiMode: 'ai_mode',
+    AiOverview: 'ai_overview',
+    Gemini: 'gemini',
+    Copilot: 'copilot',
+    AmazonRufus: 'amazon_rufus',
+    Claude: 'claude',
+    Grok: 'grok',
+    Deepseek: 'deepseek',
+    NaverAi: 'naver_ai',
+    BaiduAi: 'baidu_ai',
+    MetaAi: 'meta_ai'
+} as const;
+export type GetShareOfVoiceModelEnum = typeof GetShareOfVoiceModelEnum[keyof typeof GetShareOfVoiceModelEnum];
+/**
+ * @export
+ */
+export const GetShareOfVoiceBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+} as const;
+export type GetShareOfVoiceBrandKindEnum = typeof GetShareOfVoiceBrandKindEnum[keyof typeof GetShareOfVoiceBrandKindEnum];
+/**
+ * @export
+ */
+export const GetShareOfVoiceOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+} as const;
+export type GetShareOfVoiceOutputEnum = typeof GetShareOfVoiceOutputEnum[keyof typeof GetShareOfVoiceOutputEnum];
+/**
+ * @export
+ */
+export const GetShareOfVoiceViewEnum = {
+    OverTime: 'over_time',
+    Current: 'current',
+    Breakdown: 'breakdown'
+} as const;
+export type GetShareOfVoiceViewEnum = typeof GetShareOfVoiceViewEnum[keyof typeof GetShareOfVoiceViewEnum];
+/**
+ * @export
+ */
+export const GetSummaryGranularityEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month'
+} as const;
+export type GetSummaryGranularityEnum = typeof GetSummaryGranularityEnum[keyof typeof GetSummaryGranularityEnum];
+/**
+ * @export
+ */
+export const GetSummaryModelEnum = {
+    Chatgpt: 'chatgpt',
+    Perplexity: 'perplexity',
+    AiMode: 'ai_mode',
+    AiOverview: 'ai_overview',
+    Gemini: 'gemini',
+    Copilot: 'copilot',
+    AmazonRufus: 'amazon_rufus',
+    Claude: 'claude',
+    Grok: 'grok',
+    Deepseek: 'deepseek',
+    NaverAi: 'naver_ai',
+    BaiduAi: 'baidu_ai',
+    MetaAi: 'meta_ai'
+} as const;
+export type GetSummaryModelEnum = typeof GetSummaryModelEnum[keyof typeof GetSummaryModelEnum];
+/**
+ * @export
+ */
+export const GetSummaryBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+} as const;
+export type GetSummaryBrandKindEnum = typeof GetSummaryBrandKindEnum[keyof typeof GetSummaryBrandKindEnum];
+/**
+ * @export
+ */
+export const GetSummaryOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+} as const;
+export type GetSummaryOutputEnum = typeof GetSummaryOutputEnum[keyof typeof GetSummaryOutputEnum];
+/**
+ * @export
+ */
+export const GetTimeseriesGranularityEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month'
+} as const;
+export type GetTimeseriesGranularityEnum = typeof GetTimeseriesGranularityEnum[keyof typeof GetTimeseriesGranularityEnum];
+/**
+ * @export
+ */
+export const GetTimeseriesModelEnum = {
+    Chatgpt: 'chatgpt',
+    Perplexity: 'perplexity',
+    AiMode: 'ai_mode',
+    AiOverview: 'ai_overview',
+    Gemini: 'gemini',
+    Copilot: 'copilot',
+    AmazonRufus: 'amazon_rufus',
+    Claude: 'claude',
+    Grok: 'grok',
+    Deepseek: 'deepseek',
+    NaverAi: 'naver_ai',
+    BaiduAi: 'baidu_ai',
+    MetaAi: 'meta_ai'
+} as const;
+export type GetTimeseriesModelEnum = typeof GetTimeseriesModelEnum[keyof typeof GetTimeseriesModelEnum];
+/**
+ * @export
+ */
+export const GetTimeseriesBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+} as const;
+export type GetTimeseriesBrandKindEnum = typeof GetTimeseriesBrandKindEnum[keyof typeof GetTimeseriesBrandKindEnum];
+/**
+ * @export
+ */
+export const GetTimeseriesOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+} as const;
+export type GetTimeseriesOutputEnum = typeof GetTimeseriesOutputEnum[keyof typeof GetTimeseriesOutputEnum];
+/**
+ * @export
+ */
+export const GetTopSourcesModelEnum = {
+    Chatgpt: 'chatgpt',
+    Perplexity: 'perplexity',
+    AiMode: 'ai_mode',
+    AiOverview: 'ai_overview',
+    Gemini: 'gemini',
+    Copilot: 'copilot',
+    AmazonRufus: 'amazon_rufus',
+    Claude: 'claude',
+    Grok: 'grok',
+    Deepseek: 'deepseek',
+    NaverAi: 'naver_ai',
+    BaiduAi: 'baidu_ai',
+    MetaAi: 'meta_ai'
+} as const;
+export type GetTopSourcesModelEnum = typeof GetTopSourcesModelEnum[keyof typeof GetTopSourcesModelEnum];
+/**
+ * @export
+ */
+export const GetTopSourcesBrandKindEnum = {
+    Brand: 'brand',
+    BrandOther: 'brand_other',
+    NonBrand: 'non_brand'
+} as const;
+export type GetTopSourcesBrandKindEnum = typeof GetTopSourcesBrandKindEnum[keyof typeof GetTopSourcesBrandKindEnum];
+/**
+ * @export
+ */
+export const GetTopSourcesSortEnum = {
+    TotalResponses: 'total_responses',
+    AvgMentionRate: 'avg_mention_rate',
+    AvgVisibility: 'avg_visibility'
+} as const;
+export type GetTopSourcesSortEnum = typeof GetTopSourcesSortEnum[keyof typeof GetTopSourcesSortEnum];
+/**
+ * @export
+ */
+export const GetTopSourcesOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+} as const;
+export type GetTopSourcesOutputEnum = typeof GetTopSourcesOutputEnum[keyof typeof GetTopSourcesOutputEnum];