@llmpulse/sdk 0.0.0-stage → 1.60.0

package/dist/esm/apis/AIAgentTrafficApi.js

@@ -0,0 +1,350 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.60.0
+ * Contact: info@llmpulse.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { AgentBotsResponseFromJSON, } from '../models/AgentBotsResponse';
+import { AgentTrafficResponseFromJSON, } from '../models/AgentTrafficResponse';
+import { QueryWebAnalyticsRequestToJSON, } from '../models/QueryWebAnalyticsRequest';
+import { WebAnalyticsQueryResponseFromJSON, } from '../models/WebAnalyticsQueryResponse';
+import { WebAnalyticsSchemaResponseFromJSON, } from '../models/WebAnalyticsSchemaResponse';
+/**
+ *
+ */
+export class AIAgentTrafficApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getAgentTraffic without sending the request
+     */
+    getAgentTrafficRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['projectId'] == null) {
+                throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling getAgentTraffic().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            if (requestParameters['range'] != null) {
+                queryParameters['range'] = requestParameters['range'];
+            }
+            if (requestParameters['from'] != null) {
+                queryParameters['from'] = requestParameters['from'].toISOString();
+            }
+            if (requestParameters['to'] != null) {
+                queryParameters['to'] = requestParameters['to'].toISOString();
+            }
+            if (requestParameters['bot'] != null) {
+                queryParameters['bot'] = requestParameters['bot'];
+            }
+            if (requestParameters['company'] != null) {
+                queryParameters['company'] = requestParameters['company'];
+            }
+            if (requestParameters['groupBy'] != null) {
+                queryParameters['group_by'] = requestParameters['groupBy'];
+            }
+            if (requestParameters['granularity'] != null) {
+                queryParameters['granularity'] = requestParameters['granularity'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/metrics/agent_traffic`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Aggregated AI bot traffic hitting the project\'s origin server (GPTBot, PerplexityBot, ClaudeBot, OAI-SearchBot, Google-Extended, etc.). Sourced from Cloudflare or CSV uploads. Requires the Scale plan; lower tiers receive ERR_PLAN_REQUIRED. A range below 1, or a window whose from is later than its to, returns ERR_INVALID_PARAM.
+     * AI bot crawler traffic (Scale plan or above, Beta)
+     */
+    getAgentTrafficRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAgentTrafficRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AgentTrafficResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Aggregated AI bot traffic hitting the project\'s origin server (GPTBot, PerplexityBot, ClaudeBot, OAI-SearchBot, Google-Extended, etc.). Sourced from Cloudflare or CSV uploads. Requires the Scale plan; lower tiers receive ERR_PLAN_REQUIRED. A range below 1, or a window whose from is later than its to, returns ERR_INVALID_PARAM.
+     * AI bot crawler traffic (Scale plan or above, Beta)
+     */
+    getAgentTraffic(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getAgentTrafficRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getAiTraffic without sending the request
+     */
+    getAiTrafficRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['projectId'] == null) {
+                throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling getAiTraffic().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            if (requestParameters['range'] != null) {
+                queryParameters['range'] = requestParameters['range'];
+            }
+            if (requestParameters['from'] != null) {
+                queryParameters['from'] = requestParameters['from'].toISOString();
+            }
+            if (requestParameters['to'] != null) {
+                queryParameters['to'] = requestParameters['to'].toISOString();
+            }
+            if (requestParameters['source'] != null) {
+                queryParameters['source'] = requestParameters['source'];
+            }
+            if (requestParameters['granularity'] != null) {
+                queryParameters['granularity'] = requestParameters['granularity'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/metrics/ai_traffic`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * AI referral traffic for a project: human visits arriving from AI assistants (ChatGPT, Perplexity, Gemini, Claude, etc.), measured from the connected web analytics provider (Google Analytics 4, Adobe Analytics, PostHog, Plausible, Matomo or Piano). Returns per-source users, sessions and conversions with totals and a conversion rate. Requires a connected provider and the Scale plan; otherwise returns ERR_AI_TRAFFIC_NOT_CONNECTED or ERR_PLAN_REQUIRED. A range below 1, or a window whose from is later than its to, returns ERR_INVALID_PARAM.
+     * AI referral traffic (Scale plan or above)
+     */
+    getAiTrafficRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAiTrafficRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * AI referral traffic for a project: human visits arriving from AI assistants (ChatGPT, Perplexity, Gemini, Claude, etc.), measured from the connected web analytics provider (Google Analytics 4, Adobe Analytics, PostHog, Plausible, Matomo or Piano). Returns per-source users, sessions and conversions with totals and a conversion rate. Requires a connected provider and the Scale plan; otherwise returns ERR_AI_TRAFFIC_NOT_CONNECTED or ERR_PLAN_REQUIRED. A range below 1, or a window whose from is later than its to, returns ERR_INVALID_PARAM.
+     * AI referral traffic (Scale plan or above)
+     */
+    getAiTraffic(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.getAiTrafficRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getWebAnalyticsSchema without sending the request
+     */
+    getWebAnalyticsSchemaRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['projectId'] == null) {
+                throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling getWebAnalyticsSchema().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/web_analytics/schema`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * How to query the web analytics provider connected to the project, live: the provider, the property every query runs on, the native query format it accepts, the allowed top-level fields, the rules the bridge enforces (the connected property is always used, only reads run, row limits), a worked example and, where the provider offers it, its live field list. Cached for an hour. Supported providers: Google Analytics 4, Adobe Analytics or Customer Journey Analytics, Matomo, PostHog, Plausible and Piano, connected on the AI Traffic page. Requires the Growth plan or above; otherwise ERR_PLAN_REQUIRED. Without a connected provider returns ERR_WEB_ANALYTICS_NOT_CONNECTED (404); a provider that refuses the stored credentials returns ERR_WEB_ANALYTICS_ACCESS_REVOKED (403); an unavailable provider, an exhausted provider quota, more than 20 uncached queries a minute or too many running at once for the project returns ERR_WEB_ANALYTICS_UPSTREAM (503): wait for the number of seconds in Retry-After before retrying.
+     * Web analytics query format (Growth+)
+     */
+    getWebAnalyticsSchemaRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getWebAnalyticsSchemaRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => WebAnalyticsSchemaResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * How to query the web analytics provider connected to the project, live: the provider, the property every query runs on, the native query format it accepts, the allowed top-level fields, the rules the bridge enforces (the connected property is always used, only reads run, row limits), a worked example and, where the provider offers it, its live field list. Cached for an hour. Supported providers: Google Analytics 4, Adobe Analytics or Customer Journey Analytics, Matomo, PostHog, Plausible and Piano, connected on the AI Traffic page. Requires the Growth plan or above; otherwise ERR_PLAN_REQUIRED. Without a connected provider returns ERR_WEB_ANALYTICS_NOT_CONNECTED (404); a provider that refuses the stored credentials returns ERR_WEB_ANALYTICS_ACCESS_REVOKED (403); an unavailable provider, an exhausted provider quota, more than 20 uncached queries a minute or too many running at once for the project returns ERR_WEB_ANALYTICS_UPSTREAM (503): wait for the number of seconds in Retry-After before retrying.
+     * Web analytics query format (Growth+)
+     */
+    getWebAnalyticsSchema(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getWebAnalyticsSchemaRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listAgentBots without sending the request
+     */
+    listAgentBotsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['projectId'] == null) {
+                throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling listAgentBots().');
+            }
+            const queryParameters = {};
+            if (requestParameters['projectId'] != null) {
+                queryParameters['project_id'] = requestParameters['projectId'];
+            }
+            if (requestParameters['output'] != null) {
+                queryParameters['output'] = requestParameters['output'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/dimensions/agent_bots`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Static catalog of AI bots that Agent Analytics can identify. Useful for rendering filter UIs that mirror our internal classification (slug, display name, company, category, Cloudflare verified-bot mapping, description). Requires the Scale plan; lower tiers receive ERR_PLAN_REQUIRED. The equivalent MCP tool list_agent_bots is available on the Scale plan or above.
+     * AI bot catalog (Scale plan or above)
+     */
+    listAgentBotsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listAgentBotsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AgentBotsResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Static catalog of AI bots that Agent Analytics can identify. Useful for rendering filter UIs that mirror our internal classification (slug, display name, company, category, Cloudflare verified-bot mapping, description). Requires the Scale plan; lower tiers receive ERR_PLAN_REQUIRED. The equivalent MCP tool list_agent_bots is available on the Scale plan or above.
+     * AI bot catalog (Scale plan or above)
+     */
+    listAgentBots(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listAgentBotsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for queryWebAnalytics without sending the request
+     */
+    queryWebAnalyticsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['queryWebAnalyticsRequest'] == null) {
+                throw new runtime.RequiredError('queryWebAnalyticsRequest', 'Required parameter "queryWebAnalyticsRequest" was null or undefined when calling queryWebAnalytics().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("BearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/web_analytics/query`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: QueryWebAnalyticsRequestToJSON(requestParameters['queryWebAnalyticsRequest']),
+            };
+        });
+    }
+    /**
+     * Runs a read-only query, written in the connected provider\'s native format, against the project\'s property and returns columns and rows: a GA4 Data API runReport body, an Adobe Analytics or Customer Journey Analytics report request, Matomo Reporting API parameters (get methods only), PostHog HogQL, a Plausible Stats API v2 query or a Piano getData body. The connected property, site, report suite or project is always used and any property field in the query is ignored. Rows default to 100 and are capped at 5,000. Identical queries are answered from a 10-minute cache (cached: true). A query the provider rejects returns ERR_WEB_ANALYTICS_INVALID_QUERY (422) with the provider\'s own validation message. Each uncached query spends the customer\'s provider API quota. A read: no writable key is needed. Supported providers: Google Analytics 4, Adobe Analytics or Customer Journey Analytics, Matomo, PostHog, Plausible and Piano, connected on the AI Traffic page. Requires the Growth plan or above; otherwise ERR_PLAN_REQUIRED. Without a connected provider returns ERR_WEB_ANALYTICS_NOT_CONNECTED (404); a provider that refuses the stored credentials returns ERR_WEB_ANALYTICS_ACCESS_REVOKED (403); an unavailable provider, an exhausted provider quota, more than 20 uncached queries a minute or too many running at once for the project returns ERR_WEB_ANALYTICS_UPSTREAM (503): wait for the number of seconds in Retry-After before retrying.
+     * Live web analytics query (Growth+)
+     */
+    queryWebAnalyticsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.queryWebAnalyticsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => WebAnalyticsQueryResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Runs a read-only query, written in the connected provider\'s native format, against the project\'s property and returns columns and rows: a GA4 Data API runReport body, an Adobe Analytics or Customer Journey Analytics report request, Matomo Reporting API parameters (get methods only), PostHog HogQL, a Plausible Stats API v2 query or a Piano getData body. The connected property, site, report suite or project is always used and any property field in the query is ignored. Rows default to 100 and are capped at 5,000. Identical queries are answered from a 10-minute cache (cached: true). A query the provider rejects returns ERR_WEB_ANALYTICS_INVALID_QUERY (422) with the provider\'s own validation message. Each uncached query spends the customer\'s provider API quota. A read: no writable key is needed. Supported providers: Google Analytics 4, Adobe Analytics or Customer Journey Analytics, Matomo, PostHog, Plausible and Piano, connected on the AI Traffic page. Requires the Growth plan or above; otherwise ERR_PLAN_REQUIRED. Without a connected provider returns ERR_WEB_ANALYTICS_NOT_CONNECTED (404); a provider that refuses the stored credentials returns ERR_WEB_ANALYTICS_ACCESS_REVOKED (403); an unavailable provider, an exhausted provider quota, more than 20 uncached queries a minute or too many running at once for the project returns ERR_WEB_ANALYTICS_UPSTREAM (503): wait for the number of seconds in Retry-After before retrying.
+     * Live web analytics query (Growth+)
+     */
+    queryWebAnalytics(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.queryWebAnalyticsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const GetAgentTrafficGroupByEnum = {
+    Bot: 'bot',
+    Company: 'company'
+};
+/**
+ * @export
+ */
+export const GetAgentTrafficGranularityEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month'
+};
+/**
+ * @export
+ */
+export const GetAiTrafficGranularityEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month'
+};
+/**
+ * @export
+ */
+export const ListAgentBotsOutputEnum = {
+    Flat: 'flat',
+    Csv: 'csv'
+};

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

@@ -0,0 +1,305 @@
+/**
+ * LLM Pulse API
+ * REST API client for LLM Pulse AI visibility analytics.
+ *
+ * The version of the OpenAPI document: 1.60.0
+ * Contact: info@llmpulse.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+export interface GetAiModelInsightsSummaryRequest {
+    projectId: number;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    granularity?: GetAiModelInsightsSummaryGranularityEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    promptType?: string;
+    brandKind?: GetAiModelInsightsSummaryBrandKindEnum;
+    competitors?: string;
+}
+export interface GetAiModelPositionDistributionRequest {
+    projectId: number;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    granularity?: GetAiModelPositionDistributionGranularityEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    promptType?: string;
+    brandKind?: GetAiModelPositionDistributionBrandKindEnum;
+    model?: GetAiModelPositionDistributionModelEnum;
+    brand1?: number;
+    brand2?: number;
+}
+export interface GetAiOverviewResultsRequest {
+    projectId: number;
+    range?: number;
+    from?: Date;
+    to?: Date;
+    granularity?: GetAiOverviewResultsGranularityEnum;
+    collectionId?: string;
+    countryCode?: string;
+    languageCode?: string;
+    promptType?: string;
+    brandKind?: GetAiOverviewResultsBrandKindEnum;
+    page?: number;
+    perPage?: number;
+}
+/**
+ * AIModelInsightsApi - interface
+ *
+ * @export
+ * @interface AIModelInsightsApiInterface
+ */
+export interface AIModelInsightsApiInterface {
+    /**
+     * Creates request options for getAiModelInsightsSummary 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} [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 {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 {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @throws {RequiredError}
+     * @memberof AIModelInsightsApiInterface
+     */
+    getAiModelInsightsSummaryRequestOpts(requestParameters: GetAiModelInsightsSummaryRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Per-model mentions, citations, brand net sentiment with raw counts, weighted visibility totals/shares, plus actor matrices. All actor entries use the standard shape `{ type, id, competitor_id, name, domain }` with bare (scheme-less) domains.
+     * @summary AI Model Insights 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 {'day' | 'week' | 'month'} [granularity]
+     * @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 {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 {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AIModelInsightsApiInterface
+     */
+    getAiModelInsightsSummaryRaw(requestParameters: GetAiModelInsightsSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Per-model mentions, citations, brand net sentiment with raw counts, weighted visibility totals/shares, plus actor matrices. All actor entries use the standard shape `{ type, id, competitor_id, name, domain }` with bare (scheme-less) domains.
+     * AI Model Insights summary
+     */
+    getAiModelInsightsSummary(requestParameters: GetAiModelInsightsSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getAiModelPositionDistribution 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} [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 {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 {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Restrict the comparison to one AI model: chatgpt, ai_mode, ai_overview, perplexity, gemini, naver_ai or baidu_ai, whether or not that model is enabled for the API key\&#39;s user. Any other value returns 422 ERR_INVALID_PARAM (invalid model).
+     * @param {number} [brand1] Competitor ID for the first comparison brand (omit to compare project brand)
+     * @param {number} [brand2]
+     * @throws {RequiredError}
+     * @memberof AIModelInsightsApiInterface
+     */
+    getAiModelPositionDistributionRequestOpts(requestParameters: GetAiModelPositionDistributionRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary Position distribution comparison
+     * @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} [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 {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 {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Restrict the comparison to one AI model: chatgpt, ai_mode, ai_overview, perplexity, gemini, naver_ai or baidu_ai, whether or not that model is enabled for the API key\&#39;s user. Any other value returns 422 ERR_INVALID_PARAM (invalid model).
+     * @param {number} [brand1] Competitor ID for the first comparison brand (omit to compare project brand)
+     * @param {number} [brand2]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AIModelInsightsApiInterface
+     */
+    getAiModelPositionDistributionRaw(requestParameters: GetAiModelPositionDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Position distribution comparison
+     */
+    getAiModelPositionDistribution(requestParameters: GetAiModelPositionDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getAiOverviewResults 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} [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 {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 {number} [page]
+     * @param {number} [perPage]
+     * @throws {RequiredError}
+     * @memberof AIModelInsightsApiInterface
+     */
+    getAiOverviewResultsRequestOpts(requestParameters: GetAiOverviewResultsRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary Google AI Overview result availability
+     * @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} [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 {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 {number} [page]
+     * @param {number} [perPage]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AIModelInsightsApiInterface
+     */
+    getAiOverviewResultsRaw(requestParameters: GetAiOverviewResultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Google AI Overview result availability
+     */
+    getAiOverviewResults(requestParameters: GetAiOverviewResultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class AIModelInsightsApi extends runtime.BaseAPI implements AIModelInsightsApiInterface {
+    /**
+     * Creates request options for getAiModelInsightsSummary without sending the request
+     */
+    getAiModelInsightsSummaryRequestOpts(requestParameters: GetAiModelInsightsSummaryRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Per-model mentions, citations, brand net sentiment with raw counts, weighted visibility totals/shares, plus actor matrices. All actor entries use the standard shape `{ type, id, competitor_id, name, domain }` with bare (scheme-less) domains.
+     * AI Model Insights summary
+     */
+    getAiModelInsightsSummaryRaw(requestParameters: GetAiModelInsightsSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Per-model mentions, citations, brand net sentiment with raw counts, weighted visibility totals/shares, plus actor matrices. All actor entries use the standard shape `{ type, id, competitor_id, name, domain }` with bare (scheme-less) domains.
+     * AI Model Insights summary
+     */
+    getAiModelInsightsSummary(requestParameters: GetAiModelInsightsSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getAiModelPositionDistribution without sending the request
+     */
+    getAiModelPositionDistributionRequestOpts(requestParameters: GetAiModelPositionDistributionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Position distribution comparison
+     */
+    getAiModelPositionDistributionRaw(requestParameters: GetAiModelPositionDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Position distribution comparison
+     */
+    getAiModelPositionDistribution(requestParameters: GetAiModelPositionDistributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getAiOverviewResults without sending the request
+     */
+    getAiOverviewResultsRequestOpts(requestParameters: GetAiOverviewResultsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Google AI Overview result availability
+     */
+    getAiOverviewResultsRaw(requestParameters: GetAiOverviewResultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Google AI Overview result availability
+     */
+    getAiOverviewResults(requestParameters: GetAiOverviewResultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ * @export
+ */
+export declare const GetAiModelInsightsSummaryGranularityEnum: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+};
+export type GetAiModelInsightsSummaryGranularityEnum = typeof GetAiModelInsightsSummaryGranularityEnum[keyof typeof GetAiModelInsightsSummaryGranularityEnum];
+/**
+ * @export
+ */
+export declare const GetAiModelInsightsSummaryBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type GetAiModelInsightsSummaryBrandKindEnum = typeof GetAiModelInsightsSummaryBrandKindEnum[keyof typeof GetAiModelInsightsSummaryBrandKindEnum];
+/**
+ * @export
+ */
+export declare const GetAiModelPositionDistributionGranularityEnum: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+};
+export type GetAiModelPositionDistributionGranularityEnum = typeof GetAiModelPositionDistributionGranularityEnum[keyof typeof GetAiModelPositionDistributionGranularityEnum];
+/**
+ * @export
+ */
+export declare const GetAiModelPositionDistributionBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type GetAiModelPositionDistributionBrandKindEnum = typeof GetAiModelPositionDistributionBrandKindEnum[keyof typeof GetAiModelPositionDistributionBrandKindEnum];
+/**
+ * @export
+ */
+export declare const GetAiModelPositionDistributionModelEnum: {
+    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 GetAiModelPositionDistributionModelEnum = typeof GetAiModelPositionDistributionModelEnum[keyof typeof GetAiModelPositionDistributionModelEnum];
+/**
+ * @export
+ */
+export declare const GetAiOverviewResultsGranularityEnum: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+};
+export type GetAiOverviewResultsGranularityEnum = typeof GetAiOverviewResultsGranularityEnum[keyof typeof GetAiOverviewResultsGranularityEnum];
+/**
+ * @export
+ */
+export declare const GetAiOverviewResultsBrandKindEnum: {
+    readonly Brand: "brand";
+    readonly BrandOther: "brand_other";
+    readonly NonBrand: "non_brand";
+};
+export type GetAiOverviewResultsBrandKindEnum = typeof GetAiOverviewResultsBrandKindEnum[keyof typeof GetAiOverviewResultsBrandKindEnum];