@llmpulse/sdk 0.0.0-stage → 1.59.0

package/dist/esm/apis/MetricsApi.d.ts

@@ -0,0 +1,684 @@
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.59.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 PromptSummaryResponse } from '../models/PromptSummaryResponse';
+import { type SovResponse } from '../models/SovResponse';
+import { type SummaryResponse } from '../models/SummaryResponse';
+import { type TimeseriesResponse } from '../models/TimeseriesResponse';
+import { type TopSourcesResponse } 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 AI model. Models the API key\'s user has not enabled are silently dropped.
+     * @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 AI model. Models the API key\&#39;s user has not enabled are silently dropped.
+     * @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 AI model. Models the API key\&#39;s user has not enabled are silently dropped.
+     * @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 AI model. Models the API key\&#39;s user has not enabled are silently dropped.
+     * @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 AI model. Models the API key\&#39;s user has not enabled are silently dropped.
+     * @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 AI model. Models the API key\&#39;s user has not enabled are silently dropped.
+     * @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 AI model. Models the API key\&#39;s user has not enabled are silently dropped.
+     * @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 AI model. Models the API key\&#39;s user has not enabled are silently dropped.
+     * @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 AI model. Models the API key\&#39;s user has not enabled are silently dropped.
+     * @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 AI model. Models the API key\&#39;s user has not enabled are silently dropped.
+     * @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 declare class MetricsApi extends runtime.BaseAPI implements MetricsApiInterface {
+    /**
+     * Creates request options for getPromptSummary without sending the request
+     */
+    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.
+     * Per-prompt metrics summary
+     */
+    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
+     */
+    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.
+     * Share of Voice
+     */
+    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
+     */
+    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`).
+     * Aggregated metrics summary
+     */
+    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
+     */
+    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.
+     * Time-series metrics
+     */
+    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
+     */
+    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.
+     * Top cited sources
+     */
+    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
+ */
+export declare const GetPromptSummaryBreakdownEnum: {
+    readonly Model: "model";
+};
+export type GetPromptSummaryBreakdownEnum = typeof GetPromptSummaryBreakdownEnum[keyof typeof GetPromptSummaryBreakdownEnum];
+/**
+ * @export
+ */
+export declare const GetPromptSummaryModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type GetPromptSummaryModelEnum = typeof GetPromptSummaryModelEnum[keyof typeof GetPromptSummaryModelEnum];
+/**
+ * @export
+ */
+export declare const GetPromptSummaryBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type GetPromptSummaryBrandKindEnum = typeof GetPromptSummaryBrandKindEnum[keyof typeof GetPromptSummaryBrandKindEnum];
+/**
+ * @export
+ */
+export declare const GetPromptSummarySortEnum: {
+    readonly Responses: "responses";
+    readonly Mentions: "mentions";
+    readonly Citations: "citations";
+    readonly MentionRate: "mention_rate";
+    readonly Visibility: "visibility";
+    readonly CitationRate: "citation_rate";
+    readonly AvgMentionPosition: "avg_mention_position";
+    readonly AvgPosition: "avg_position";
+};
+export type GetPromptSummarySortEnum = typeof GetPromptSummarySortEnum[keyof typeof GetPromptSummarySortEnum];
+/**
+ * @export
+ */
+export declare const GetPromptSummarySortDirEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type GetPromptSummarySortDirEnum = typeof GetPromptSummarySortDirEnum[keyof typeof GetPromptSummarySortDirEnum];
+/**
+ * @export
+ */
+export declare const GetPromptSummaryOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type GetPromptSummaryOutputEnum = typeof GetPromptSummaryOutputEnum[keyof typeof GetPromptSummaryOutputEnum];
+/**
+ * @export
+ */
+export declare const GetShareOfVoiceGranularityEnum: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+};
+export type GetShareOfVoiceGranularityEnum = typeof GetShareOfVoiceGranularityEnum[keyof typeof GetShareOfVoiceGranularityEnum];
+/**
+ * @export
+ */
+export declare const GetShareOfVoiceModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type GetShareOfVoiceModelEnum = typeof GetShareOfVoiceModelEnum[keyof typeof GetShareOfVoiceModelEnum];
+/**
+ * @export
+ */
+export declare const GetShareOfVoiceBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type GetShareOfVoiceBrandKindEnum = typeof GetShareOfVoiceBrandKindEnum[keyof typeof GetShareOfVoiceBrandKindEnum];
+/**
+ * @export
+ */
+export declare const GetShareOfVoiceOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type GetShareOfVoiceOutputEnum = typeof GetShareOfVoiceOutputEnum[keyof typeof GetShareOfVoiceOutputEnum];
+/**
+ * @export
+ */
+export declare const GetShareOfVoiceViewEnum: {
+    readonly OverTime: "over_time";
+    readonly Current: "current";
+    readonly Breakdown: "breakdown";
+};
+export type GetShareOfVoiceViewEnum = typeof GetShareOfVoiceViewEnum[keyof typeof GetShareOfVoiceViewEnum];
+/**
+ * @export
+ */
+export declare const GetSummaryGranularityEnum: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+};
+export type GetSummaryGranularityEnum = typeof GetSummaryGranularityEnum[keyof typeof GetSummaryGranularityEnum];
+/**
+ * @export
+ */
+export declare const GetSummaryModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type GetSummaryModelEnum = typeof GetSummaryModelEnum[keyof typeof GetSummaryModelEnum];
+/**
+ * @export
+ */
+export declare const GetSummaryBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type GetSummaryBrandKindEnum = typeof GetSummaryBrandKindEnum[keyof typeof GetSummaryBrandKindEnum];
+/**
+ * @export
+ */
+export declare const GetSummaryOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type GetSummaryOutputEnum = typeof GetSummaryOutputEnum[keyof typeof GetSummaryOutputEnum];
+/**
+ * @export
+ */
+export declare const GetTimeseriesGranularityEnum: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+};
+export type GetTimeseriesGranularityEnum = typeof GetTimeseriesGranularityEnum[keyof typeof GetTimeseriesGranularityEnum];
+/**
+ * @export
+ */
+export declare const GetTimeseriesModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type GetTimeseriesModelEnum = typeof GetTimeseriesModelEnum[keyof typeof GetTimeseriesModelEnum];
+/**
+ * @export
+ */
+export declare const GetTimeseriesBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type GetTimeseriesBrandKindEnum = typeof GetTimeseriesBrandKindEnum[keyof typeof GetTimeseriesBrandKindEnum];
+/**
+ * @export
+ */
+export declare const GetTimeseriesOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type GetTimeseriesOutputEnum = typeof GetTimeseriesOutputEnum[keyof typeof GetTimeseriesOutputEnum];
+/**
+ * @export
+ */
+export declare const GetTopSourcesModelEnum: {
+    readonly Chatgpt: "chatgpt";
+    readonly Perplexity: "perplexity";
+    readonly AiMode: "ai_mode";
+    readonly AiOverview: "ai_overview";
+    readonly Gemini: "gemini";
+    readonly Copilot: "copilot";
+    readonly AmazonRufus: "amazon_rufus";
+    readonly Claude: "claude";
+    readonly Grok: "grok";
+    readonly Deepseek: "deepseek";
+    readonly NaverAi: "naver_ai";
+    readonly BaiduAi: "baidu_ai";
+    readonly MetaAi: "meta_ai";
+};
+export type GetTopSourcesModelEnum = typeof GetTopSourcesModelEnum[keyof typeof GetTopSourcesModelEnum];
+/**
+ * @export
+ */
+export declare const GetTopSourcesBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type GetTopSourcesBrandKindEnum = typeof GetTopSourcesBrandKindEnum[keyof typeof GetTopSourcesBrandKindEnum];
+/**
+ * @export
+ */
+export declare const GetTopSourcesSortEnum: {
+    readonly TotalResponses: "total_responses";
+    readonly AvgMentionRate: "avg_mention_rate";
+    readonly AvgVisibility: "avg_visibility";
+};
+export type GetTopSourcesSortEnum = typeof GetTopSourcesSortEnum[keyof typeof GetTopSourcesSortEnum];
+/**
+ * @export
+ */
+export declare const GetTopSourcesOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type GetTopSourcesOutputEnum = typeof GetTopSourcesOutputEnum[keyof typeof GetTopSourcesOutputEnum];