@llmpulse/sdk 0.0.0-stage → 1.59.0

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

@@ -0,0 +1,531 @@
+/**
+ * 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';
+export interface GetCitedUrlContentRequest {
+    projectId: number;
+    urlSha256: string;
+}
+export interface GetCitedUrlDetailRequest {
+    projectId: number;
+    urlSha256: string;
+}
+export interface GetMentionsByCitingDomainRequest {
+    projectId: number;
+    domains: Array<string>;
+    model?: GetMentionsByCitingDomainModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    brandKind?: GetMentionsByCitingDomainBrandKindEnum;
+    from?: Date;
+    to?: Date;
+}
+export interface ListCitationGroupsRequest {
+    projectId: number;
+    view?: ListCitationGroupsViewEnum;
+    page?: number;
+    perPage?: number;
+    order?: ListCitationGroupsOrderEnum;
+    direction?: ListCitationGroupsDirectionEnum;
+    model?: ListCitationGroupsModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    from?: Date;
+    to?: Date;
+    query?: string;
+    sourceType?: ListCitationGroupsSourceTypeEnum;
+    sentiment?: ListCitationGroupsSentimentEnum;
+    contentGap?: ListCitationGroupsContentGapEnum;
+}
+export interface ListCitedUrlOccurrencesRequest {
+    projectId: number;
+    urlSha256: string;
+    page?: number;
+    perPage?: number;
+}
+export interface ListSourcesRequest {
+    projectId: number;
+    page?: number;
+    perPage?: number;
+    model?: ListSourcesModelEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    prompt?: number;
+    from?: Date;
+    to?: Date;
+    sourceType?: ListSourcesSourceTypeEnum;
+    mentionFilter?: ListSourcesMentionFilterEnum;
+    competitors?: string;
+    output?: ListSourcesOutputEnum;
+}
+/**
+ * SourcesCitationIntelligenceApi - interface
+ *
+ * @export
+ * @interface SourcesCitationIntelligenceApiInterface
+ */
+export interface SourcesCitationIntelligenceApiInterface {
+    /**
+     * Creates request options for getCitedUrlContent without sending the request
+     * @param {number} projectId Project ID
+     * @param {string} urlSha256 64-character hex SHA-256 of the cited URL
+     * @throws {RequiredError}
+     * @memberof SourcesCitationIntelligenceApiInterface
+     */
+    getCitedUrlContentRequestOpts(requestParameters: GetCitedUrlContentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.
+     * @summary Cited URL cached content
+     * @param {number} projectId Project ID
+     * @param {string} urlSha256 64-character hex SHA-256 of the cited URL
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SourcesCitationIntelligenceApiInterface
+     */
+    getCitedUrlContentRaw(requestParameters: GetCitedUrlContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.
+     * Cited URL cached content
+     */
+    getCitedUrlContent(requestParameters: GetCitedUrlContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCitedUrlDetail without sending the request
+     * @param {number} projectId Project ID
+     * @param {string} urlSha256 64-character hex SHA-256 of the cited URL
+     * @throws {RequiredError}
+     * @memberof SourcesCitationIntelligenceApiInterface
+     */
+    getCitedUrlDetailRequestOpts(requestParameters: GetCitedUrlDetailRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.
+     * @summary Cited URL detail
+     * @param {number} projectId Project ID
+     * @param {string} urlSha256 64-character hex SHA-256 of the cited URL
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SourcesCitationIntelligenceApiInterface
+     */
+    getCitedUrlDetailRaw(requestParameters: GetCitedUrlDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.
+     * Cited URL detail
+     */
+    getCitedUrlDetail(requestParameters: GetCitedUrlDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getMentionsByCitingDomain without sending the request
+     * @param {number} projectId Project ID
+     * @param {Array<string>} domains Source domains to analyze, e.g. domains[]&#x3D;gmac.com&amp;domains[]&#x3D;educaweb.com
+     * @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 {'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 {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.
+     * @throws {RequiredError}
+     * @memberof SourcesCitationIntelligenceApiInterface
+     */
+    getMentionsByCitingDomainRequestOpts(requestParameters: GetMentionsByCitingDomainRequest): Promise<runtime.RequestOpts>;
+    /**
+     * For the responses where each given source domain is cited, returns the share of those responses that mention the brand vs each competitor (brand + competitors sum to 100% per domain). Pass multiple domains to get the whole matrix in one call.
+     * @summary Mention share by citing domain
+     * @param {number} projectId Project ID
+     * @param {Array<string>} domains Source domains to analyze, e.g. domains[]&#x3D;gmac.com&amp;domains[]&#x3D;educaweb.com
+     * @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 {'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 {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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SourcesCitationIntelligenceApiInterface
+     */
+    getMentionsByCitingDomainRaw(requestParameters: GetMentionsByCitingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * For the responses where each given source domain is cited, returns the share of those responses that mention the brand vs each competitor (brand + competitors sum to 100% per domain). Pass multiple domains to get the whole matrix in one call.
+     * Mention share by citing domain
+     */
+    getMentionsByCitingDomain(requestParameters: GetMentionsByCitingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listCitationGroups without sending the request
+     * @param {number} projectId Project ID
+     * @param {'url' | 'domain' | 'host'} [view]
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'group_key' | 'total_responses' | 'total_citations' | 'citation_rate' | 'avg_citation_position' | 'first_seen_at' | 'last_seen_at'} [order]
+     * @param {'asc' | 'desc'} [direction]
+     * @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 {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} [query]
+     * @param {'owned' | 'competitor' | 'third_party' | 'social_media' | 'own_domain' | 'ugc' | 'background'} [sourceType]
+     * @param {'negative'} [sentiment]
+     * @param {'mentioned' | 'gap'} [contentGap] mentioned: the cited page mentions your brand. gap: it mentions a competitor but not your brand. Only pages with usable content whose mention analysis has completed for this project match.
+     * @throws {RequiredError}
+     * @memberof SourcesCitationIntelligenceApiInterface
+     */
+    listCitationGroupsRequestOpts(requestParameters: ListCitationGroupsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Grouped citation intelligence by url / domain / host with per-model breakdown, citation rate, and avg citation position. Counts and citation rate include visible citations and background source references. Average position ignores rows with position=0. Owned and competitor source matching honor the project\'s exact-subdomain setting. Filter vocabulary aligns with `source_type` returned by the API. Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.
+     * @summary Grouped citation intelligence
+     * @param {number} projectId Project ID
+     * @param {'url' | 'domain' | 'host'} [view]
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {'group_key' | 'total_responses' | 'total_citations' | 'citation_rate' | 'avg_citation_position' | 'first_seen_at' | 'last_seen_at'} [order]
+     * @param {'asc' | 'desc'} [direction]
+     * @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 {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} [query]
+     * @param {'owned' | 'competitor' | 'third_party' | 'social_media' | 'own_domain' | 'ugc' | 'background'} [sourceType]
+     * @param {'negative'} [sentiment]
+     * @param {'mentioned' | 'gap'} [contentGap] mentioned: the cited page mentions your brand. gap: it mentions a competitor but not your brand. Only pages with usable content whose mention analysis has completed for this project match.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SourcesCitationIntelligenceApiInterface
+     */
+    listCitationGroupsRaw(requestParameters: ListCitationGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Grouped citation intelligence by url / domain / host with per-model breakdown, citation rate, and avg citation position. Counts and citation rate include visible citations and background source references. Average position ignores rows with position=0. Owned and competitor source matching honor the project\'s exact-subdomain setting. Filter vocabulary aligns with `source_type` returned by the API. Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.
+     * Grouped citation intelligence
+     */
+    listCitationGroups(requestParameters: ListCitationGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listCitedUrlOccurrences without sending the request
+     * @param {number} projectId Project ID
+     * @param {string} urlSha256 64-character hex SHA-256 of the cited URL
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @throws {RequiredError}
+     * @memberof SourcesCitationIntelligenceApiInterface
+     */
+    listCitedUrlOccurrencesRequestOpts(requestParameters: ListCitedUrlOccurrencesRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary Cited URL occurrences
+     * @param {number} projectId Project ID
+     * @param {string} urlSha256 64-character hex SHA-256 of the cited URL
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SourcesCitationIntelligenceApiInterface
+     */
+    listCitedUrlOccurrencesRaw(requestParameters: ListCitedUrlOccurrencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Cited URL occurrences
+     */
+    listCitedUrlOccurrences(requestParameters: ListCitedUrlOccurrencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listSources without sending the request
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @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 {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 {'owned' | 'competitor' | 'third_party'} [sourceType] Filter by source ownership. Owned and competitor matching honor the project\&#39;s exact-subdomain setting.
+     * @param {'mentions_you' | 'not_mentions_you' | 'mentions_competitor' | 'not_mentions_competitor' | 'you_and_competitor' | 'competitor_not_you' | 'you_not_competitor' | 'no_brands'} [mentionFilter] Filter by which brands are mentioned, as a two-axis matrix (your brand x competitors): mentions_you / not_mentions_you, mentions_competitor / not_mentions_competitor, and the four combined cells you_and_competitor, competitor_not_you (a rival wins and you are absent), you_not_competitor, no_brands (no tracked brand appears, i.e. open space). Combine with \&#39;competitors\&#39; to narrow the competitor side to specific rivals; on a negative cell that reads \&#39;none of these\&#39;. On /dimensions/sources it applies to the crawled content of each cited page instead of the answer text. The legacy value \&#39;competitors_only\&#39; is still accepted as an alias of competitor_not_you.
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @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 SourcesCitationIntelligenceApiInterface
+     */
+    listSourcesRequestOpts(requestParameters: ListSourcesRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary List source URLs
+     * @param {number} projectId Project ID
+     * @param {number} [page]
+     * @param {number} [perPage]
+     * @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 {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 {'owned' | 'competitor' | 'third_party'} [sourceType] Filter by source ownership. Owned and competitor matching honor the project\&#39;s exact-subdomain setting.
+     * @param {'mentions_you' | 'not_mentions_you' | 'mentions_competitor' | 'not_mentions_competitor' | 'you_and_competitor' | 'competitor_not_you' | 'you_not_competitor' | 'no_brands'} [mentionFilter] Filter by which brands are mentioned, as a two-axis matrix (your brand x competitors): mentions_you / not_mentions_you, mentions_competitor / not_mentions_competitor, and the four combined cells you_and_competitor, competitor_not_you (a rival wins and you are absent), you_not_competitor, no_brands (no tracked brand appears, i.e. open space). Combine with \&#39;competitors\&#39; to narrow the competitor side to specific rivals; on a negative cell that reads \&#39;none of these\&#39;. On /dimensions/sources it applies to the crawled content of each cited page instead of the answer text. The legacy value \&#39;competitors_only\&#39; is still accepted as an alias of competitor_not_you.
+     * @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @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 SourcesCitationIntelligenceApiInterface
+     */
+    listSourcesRaw(requestParameters: ListSourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * List source URLs
+     */
+    listSources(requestParameters: ListSourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class SourcesCitationIntelligenceApi extends runtime.BaseAPI implements SourcesCitationIntelligenceApiInterface {
+    /**
+     * Creates request options for getCitedUrlContent without sending the request
+     */
+    getCitedUrlContentRequestOpts(requestParameters: GetCitedUrlContentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.
+     * Cited URL cached content
+     */
+    getCitedUrlContentRaw(requestParameters: GetCitedUrlContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.
+     * Cited URL cached content
+     */
+    getCitedUrlContent(requestParameters: GetCitedUrlContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCitedUrlDetail without sending the request
+     */
+    getCitedUrlDetailRequestOpts(requestParameters: GetCitedUrlDetailRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.
+     * Cited URL detail
+     */
+    getCitedUrlDetailRaw(requestParameters: GetCitedUrlDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.
+     * Cited URL detail
+     */
+    getCitedUrlDetail(requestParameters: GetCitedUrlDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getMentionsByCitingDomain without sending the request
+     */
+    getMentionsByCitingDomainRequestOpts(requestParameters: GetMentionsByCitingDomainRequest): Promise<runtime.RequestOpts>;
+    /**
+     * For the responses where each given source domain is cited, returns the share of those responses that mention the brand vs each competitor (brand + competitors sum to 100% per domain). Pass multiple domains to get the whole matrix in one call.
+     * Mention share by citing domain
+     */
+    getMentionsByCitingDomainRaw(requestParameters: GetMentionsByCitingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * For the responses where each given source domain is cited, returns the share of those responses that mention the brand vs each competitor (brand + competitors sum to 100% per domain). Pass multiple domains to get the whole matrix in one call.
+     * Mention share by citing domain
+     */
+    getMentionsByCitingDomain(requestParameters: GetMentionsByCitingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listCitationGroups without sending the request
+     */
+    listCitationGroupsRequestOpts(requestParameters: ListCitationGroupsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Grouped citation intelligence by url / domain / host with per-model breakdown, citation rate, and avg citation position. Counts and citation rate include visible citations and background source references. Average position ignores rows with position=0. Owned and competitor source matching honor the project\'s exact-subdomain setting. Filter vocabulary aligns with `source_type` returned by the API. Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.
+     * Grouped citation intelligence
+     */
+    listCitationGroupsRaw(requestParameters: ListCitationGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Grouped citation intelligence by url / domain / host with per-model breakdown, citation rate, and avg citation position. Counts and citation rate include visible citations and background source references. Average position ignores rows with position=0. Owned and competitor source matching honor the project\'s exact-subdomain setting. Filter vocabulary aligns with `source_type` returned by the API. Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.
+     * Grouped citation intelligence
+     */
+    listCitationGroups(requestParameters: ListCitationGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listCitedUrlOccurrences without sending the request
+     */
+    listCitedUrlOccurrencesRequestOpts(requestParameters: ListCitedUrlOccurrencesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Cited URL occurrences
+     */
+    listCitedUrlOccurrencesRaw(requestParameters: ListCitedUrlOccurrencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Cited URL occurrences
+     */
+    listCitedUrlOccurrences(requestParameters: ListCitedUrlOccurrencesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listSources without sending the request
+     */
+    listSourcesRequestOpts(requestParameters: ListSourcesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List source URLs
+     */
+    listSourcesRaw(requestParameters: ListSourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * List source URLs
+     */
+    listSources(requestParameters: ListSourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ * @export
+ */
+export declare const GetMentionsByCitingDomainModelEnum: {
+    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 GetMentionsByCitingDomainModelEnum = typeof GetMentionsByCitingDomainModelEnum[keyof typeof GetMentionsByCitingDomainModelEnum];
+/**
+ * @export
+ */
+export declare const GetMentionsByCitingDomainBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type GetMentionsByCitingDomainBrandKindEnum = typeof GetMentionsByCitingDomainBrandKindEnum[keyof typeof GetMentionsByCitingDomainBrandKindEnum];
+/**
+ * @export
+ */
+export declare const ListCitationGroupsViewEnum: {
+    readonly Url: "url";
+    readonly Domain: "domain";
+    readonly Host: "host";
+};
+export type ListCitationGroupsViewEnum = typeof ListCitationGroupsViewEnum[keyof typeof ListCitationGroupsViewEnum];
+/**
+ * @export
+ */
+export declare const ListCitationGroupsOrderEnum: {
+    readonly GroupKey: "group_key";
+    readonly TotalResponses: "total_responses";
+    readonly TotalCitations: "total_citations";
+    readonly CitationRate: "citation_rate";
+    readonly AvgCitationPosition: "avg_citation_position";
+    readonly FirstSeenAt: "first_seen_at";
+    readonly LastSeenAt: "last_seen_at";
+};
+export type ListCitationGroupsOrderEnum = typeof ListCitationGroupsOrderEnum[keyof typeof ListCitationGroupsOrderEnum];
+/**
+ * @export
+ */
+export declare const ListCitationGroupsDirectionEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type ListCitationGroupsDirectionEnum = typeof ListCitationGroupsDirectionEnum[keyof typeof ListCitationGroupsDirectionEnum];
+/**
+ * @export
+ */
+export declare const ListCitationGroupsModelEnum: {
+    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 ListCitationGroupsModelEnum = typeof ListCitationGroupsModelEnum[keyof typeof ListCitationGroupsModelEnum];
+/**
+ * @export
+ */
+export declare const ListCitationGroupsSourceTypeEnum: {
+    readonly Owned: "owned";
+    readonly Competitor: "competitor";
+    readonly ThirdParty: "third_party";
+    readonly SocialMedia: "social_media";
+    readonly OwnDomain: "own_domain";
+    readonly Ugc: "ugc";
+    readonly Background: "background";
+};
+export type ListCitationGroupsSourceTypeEnum = typeof ListCitationGroupsSourceTypeEnum[keyof typeof ListCitationGroupsSourceTypeEnum];
+/**
+ * @export
+ */
+export declare const ListCitationGroupsSentimentEnum: {
+    readonly Negative: "negative";
+};
+export type ListCitationGroupsSentimentEnum = typeof ListCitationGroupsSentimentEnum[keyof typeof ListCitationGroupsSentimentEnum];
+/**
+ * @export
+ */
+export declare const ListCitationGroupsContentGapEnum: {
+    readonly Mentioned: "mentioned";
+    readonly Gap: "gap";
+};
+export type ListCitationGroupsContentGapEnum = typeof ListCitationGroupsContentGapEnum[keyof typeof ListCitationGroupsContentGapEnum];
+/**
+ * @export
+ */
+export declare const ListSourcesModelEnum: {
+    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 ListSourcesModelEnum = typeof ListSourcesModelEnum[keyof typeof ListSourcesModelEnum];
+/**
+ * @export
+ */
+export declare const ListSourcesSourceTypeEnum: {
+    readonly Owned: "owned";
+    readonly Competitor: "competitor";
+    readonly ThirdParty: "third_party";
+};
+export type ListSourcesSourceTypeEnum = typeof ListSourcesSourceTypeEnum[keyof typeof ListSourcesSourceTypeEnum];
+/**
+ * @export
+ */
+export declare const ListSourcesMentionFilterEnum: {
+    readonly MentionsYou: "mentions_you";
+    readonly NotMentionsYou: "not_mentions_you";
+    readonly MentionsCompetitor: "mentions_competitor";
+    readonly NotMentionsCompetitor: "not_mentions_competitor";
+    readonly YouAndCompetitor: "you_and_competitor";
+    readonly CompetitorNotYou: "competitor_not_you";
+    readonly YouNotCompetitor: "you_not_competitor";
+    readonly NoBrands: "no_brands";
+};
+export type ListSourcesMentionFilterEnum = typeof ListSourcesMentionFilterEnum[keyof typeof ListSourcesMentionFilterEnum];
+/**
+ * @export
+ */
+export declare const ListSourcesOutputEnum: {
+    readonly Flat: "flat";
+    readonly Csv: "csv";
+};
+export type ListSourcesOutputEnum = typeof ListSourcesOutputEnum[keyof typeof ListSourcesOutputEnum];