# Keyword.com AI Visibility Tracker API - **OpenAPI Version:** `3.2.0` - **API Version:** `1.0.0` The Keyword.com AI Visibility Tracker API gives you programmatic access to the AI Visibility data you see inside the Keyword.com dashboard. It’s designed for teams who want to measure how brands and competitors appear across major AI search engine, such as ChatGPT, Perplexity, AI Overviews, and others, and bring those insights into their own internal tools, reports, and workflows. With this API, you can retrieve aggregated visibility metrics, trend comparisons, engine-level performance, topic segmentation, and brand-level benchmarking across your configured AI visibility setup. This API focuses on **high-level reporting data**, not individual executions or raw AI answers. It's ideal for dashboards, business intelligence tools, and automated reporting — not for retrieving the full text of AI engine responses. **This section covers:** - How to authenticate using your existing Keyword.com API credentials - Endpoints to retrieve AI Visibility metrics and time-series data - How filters such as timeframe, period offsets, engines, topics, and queries affect the resulting metrics - Practical examples of requests and responses - Guidance for integrating AI Visibility data alongside your SERP monitoring or internal analytics If you already use the SERP API, authentication and request structure will feel familiar — the same API token works for both. Once authenticated, you can pull: - Brand-level visibility, sentiment, and ranking metrics - Competitor benchmarks - Engine-level and topic-level trend data - Historical metrics aggregated hourly, daily, weekly, or monthly This API allows you to unify AI search performance with your existing SEO data, automate visibility reporting, and integrate Keyword.com’s AI tracking directly into your product or internal systems. ## Servers - **URL:** `https://app.keyword.com` ## Operations ### Fetch all domains - **Method:** `GET` - **Path:** `/api/v2/ai-visibility/domains` - **Tags:** Domains Retrieves all AI Visibility domains for your account #### Responses ##### Status: 200 Fetch all domains response ###### Content-Type: application/json - **`data`** `array` **Items:** - **`created_at`** `string` - **`domain`** `string` - **`id`** `integer` - **`updated_at`** `string` - **`links`** `object` - **`first`** `string` - **`last`** `string` - **`next`** `string` - **`prev`** `string` - **`meta`** `object` - **`current_page`** `integer` - **`from`** `integer` - **`last_page`** `integer` - **`links`** `array` **Items:** - **`active`** `boolean` - **`label`** `string` - **`page`** `string` - **`url`** `string` - **`path`** `string` - **`per_page`** `integer` - **`to`** `integer` - **`total`** `integer` **Example:** ```json { "data": [ { "id": 1, "domain": "", "created_at": "", "updated_at": "" } ], "links": { "first": "", "last": "", "prev": "", "next": "" }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "links": [ { "url": "", "label": "", "page": "", "active": true } ], "path": "", "per_page": 1, "to": 1, "total": 1 } } ``` ### Fetch a single domain - **Method:** `GET` - **Path:** `/api/v2/ai-visibility/domains/{domain_id}` - **Tags:** Domains Retrieves a single AI Visibility domain for your account #### Responses ##### Status: 200 Fetch a single domain ###### Content-Type: application/json - **`data`** `object` - **`created_at`** `string` - **`domain`** `string` - **`id`** `integer` - **`updated_at`** `string` **Example:** ```json { "data": { "id": 1, "domain": "", "created_at": "", "updated_at": "" } } ``` ### Fetch all search terms - **Method:** `GET` - **Path:** `/api/v2/ai-visibility/domains/{domain_id}/search-terms` - **Tags:** Domains #### Responses ##### Status: 200 Fetch all search terms ###### Content-Type: application/json - **`data`** `array` **Items:** - **`aiSearchEngines`** `array` **Items:** `string` - **`createdAt`** `string` - **`executionsAmount`** `integer` - **`id`** `string` - **`interval`** `string` - **`lastExecutionTime`** `string` - **`nextScheduledExecutionTime`** `string` - **`region`** `string` - **`searchTermTopicRef`** `object` - **`id`** `string` - **`name`** `string` - **`status`** `string` - **`tags`** `array` **Items:** `string` - **`term`** `string` - **`websearch`** `boolean` **Example:** ```json { "data": [ { "id": "", "term": "", "aiSearchEngines": [ "" ], "status": "", "executionsAmount": 1, "interval": "", "region": "", "websearch": true, "createdAt": "", "lastExecutionTime": "", "nextScheduledExecutionTime": "", "searchTermTopicRef": { "id": "", "name": "" }, "tags": [ "" ] } ] } ``` ### Fetch dashboard metrics - **Method:** `GET` - **Path:** `/api/v2/ai-visibility/domains/{domain_id}/metrics` - **Tags:** Reporting API # Dashboard Metrics Endpoint Get dashboard-ready metrics for a domain's AI visibility tracking. This endpoint returns comprehensive analytics data to power your dashboard visualizations. ## Overview This endpoint fetches detailed metrics about how a domain appears in AI-generated search responses across various AI engines. It provides insights into visibility, sentiment, mentions, citations, and competitive positioning over time. ## Query Parameters ### `topics[]` (array) Filter metrics by specific topics you want to track. - **Example:** `Ai Search visibility` - **Type:** Array of strings - **Description:** Allows you to narrow down metrics to specific topic areas ### `search_terms[]` (array) Specific search terms or queries to analyze for AI visibility. - **Example:** `How often does Keyword.com show up in AI-generated search responses?` - **Type:** Array of strings - **Description:** The actual search queries you want to track across AI engines ### `engine[]` (array) Specify which AI engine(s) to analyze. - **Example:** `chatgpt_gui` - **Type:** Array of strings - **Description:** Target specific AI platforms for your analysis ### `timeframe` (string) The time period for which to retrieve metrics. - **Example:** `30d` (30 days) - **Type:** String - **Description:** Defines the duration of the analysis period. Can be specified in days (e.g., "30d" or "30") ### `period_offset` (string) Offset for the time period to analyze historical data. - **Example:** `0` (current period) - **Type:** String - **Description:** Use "0" for the current period, or specify an offset to analyze previous periods ### `aggregation` (string) How to aggregate the time series data. - **Example:** `monthly` - **Type:** String - **Description:** Determines the granularity of time-based metrics (e.g., daily, weekly, monthly) ## Response Data The endpoint returns a comprehensive dataset including: - **Visibility Scores:** Quantitative metrics showing how prominently the domain appears in AI responses - **Sentiment Analysis:** Tone and sentiment of mentions across AI-generated content - **Mentions:** Frequency and context of domain references - **Citations:** How often the domain is cited as a source - **Competitor Analysis:** Comparative metrics against competing domains - **Time Series Data:** Historical trends based on the specified aggregation period #### Responses ##### Status: 200 Fetch dashboard metrics results ###### Content-Type: application/json - **`data`** `object` - **`competitorMetrics`** `array` **Items:** - **`appearances`** `integer` - **`avgRank`** `integer` - **`avgSentiment`** `number` - **`citationCount`** `integer` - **`detectionRate`** `integer` - **`isOwnBrand`** `boolean` - **`latestRank`** `integer` - **`latestValue`** `integer` - **`name`** `string` - **`top3`** `integer` - **`trend`** `integer` - **`validMetricsCount`** `integer` - **`variations`** `array` **Items:** `string` - **`visibilityScore`** `integer` - **`competitorTimeSeriesData`** `object` - **`daily`** `object` - **`competitors`** `array` **Items:** - **`timestamps`** `array` **Items:** - **`hourly`** `object` - **`competitors`** `array` **Items:** - **`timestamps`** `array` **Items:** - **`monthly`** `object` - **`competitors`** `array` **Items:** - **`isOwnBrand`** `boolean` - **`metrics`** `object` - **`avgPosition`** `array` **Items:** `integer` - **`citations`** `array` **Items:** `integer` - **`detectionRate`** `array` **Items:** `integer` - **`mentions`** `array` **Items:** `integer` - **`sentiment`** `array` **Items:** `number` - **`top3`** `array` **Items:** `integer` - **`visibilityScore`** `array` **Items:** `integer` - **`name`** `string` - **`variations`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`weekly`** `object` - **`competitors`** `array` **Items:** - **`timestamps`** `array` **Items:** - **`ownBrandMetrics`** `object` - **`avgPosition`** `integer` - **`citations`** `integer` - **`detectionRate`** `number` - **`engineMetricsData`** `object` - **`daily`** `array` **Items:** - **`hourly`** `array` **Items:** - **`monthly`** `array` **Items:** - **`avgPosition`** `array` **Items:** `integer` - **`brandNotFound`** `array` **Items:** `boolean` - **`citations`** `array` **Items:** `integer` - **`detectionRate`** `array` **Items:** `number` - **`engineId`** `string` - **`engineName`** `string` - **`mentions`** `array` **Items:** `integer` - **`sentiment`** `array` **Items:** `integer` - **`timestamps`** `array` **Items:** `string` - **`top3`** `array` **Items:** `number` - **`visibilityScore`** `array` **Items:** `number` - **`weekly`** `array` **Items:** - **`historicalData`** `object` - **`daily`** `object` - **`avgPosition`** `array` **Items:** `integer` - **`brandNotFound`** `array` **Items:** `boolean` - **`citations`** `array` **Items:** `integer` - **`detectionRate`** `array` **Items:** `number` - **`mentions`** `array` **Items:** `integer` - **`sentiment`** `array` **Items:** `integer` - **`timestamps`** `array` **Items:** `string` - **`top3`** `array` **Items:** `number` - **`visibilityScore`** `array` **Items:** `number` - **`hourly`** `object` - **`avgPosition`** `array` **Items:** `integer` - **`brandNotFound`** `array` **Items:** `boolean` - **`citations`** `array` **Items:** `integer` - **`detectionRate`** `array` **Items:** `number` - **`mentions`** `array` **Items:** `integer` - **`sentiment`** `array` **Items:** `integer` - **`timestamps`** `array` **Items:** `string` - **`top3`** `array` **Items:** `number` - **`visibilityScore`** `array` **Items:** `number` - **`monthly`** `object` - **`avgPosition`** `array` **Items:** `integer` - **`brandNotFound`** `array` **Items:** `boolean` - **`citations`** `array` **Items:** `integer` - **`detectionRate`** `array` **Items:** `number` - **`mentions`** `array` **Items:** `integer` - **`sentiment`** `array` **Items:** `integer` - **`timestamps`** `array` **Items:** `string` - **`top3`** `array` **Items:** `number` - **`visibilityScore`** `array` **Items:** `number` - **`weekly`** `object` - **`avgPosition`** `array` **Items:** `integer` - **`brandNotFound`** `array` **Items:** `boolean` - **`citations`** `array` **Items:** `integer` - **`detectionRate`** `array` **Items:** `number` - **`mentions`** `array` **Items:** `integer` - **`sentiment`** `array` **Items:** `integer` - **`timestamps`** `array` **Items:** `string` - **`top3`** `array` **Items:** `number` - **`visibilityScore`** `array` **Items:** `number` - **`manualBlacklist`** `array` **Items:** - **`manualWhitelist`** `array` **Items:** - **`mentions`** `integer` - **`preselectionBlacklist`** `array` **Items:** - **`preselectionWhitelist`** `array` **Items:** `string` - **`sentiment`** `integer` - **`top3`** `number` - **`topicMetricsData`** `object` - **`daily`** `array` **Items:** - **`hourly`** `array` **Items:** - **`monthly`** `array` **Items:** - **`avgPosition`** `array` **Items:** `integer` - **`brandNotFound`** `array` **Items:** `boolean` - **`citations`** `array` **Items:** `integer` - **`detectionRate`** `array` **Items:** `number` - **`mentions`** `array` **Items:** `integer` - **`sentiment`** `array` **Items:** `integer` - **`timestamps`** `array` **Items:** `string` - **`top3`** `array` **Items:** `number` - **`topicId`** `string` - **`topicName`** `string` - **`visibilityScore`** `array` **Items:** `number` - **`weekly`** `array` **Items:** - **`trends`** `object` - **`avgPosition`** `number` - **`citations`** `integer` - **`detectionRate`** `number` - **`mentions`** `integer` - **`sentiment`** `integer` - **`top3`** `number` - **`visibilityScore`** `number` - **`validMetricsCount`** `integer` - **`visibilityScore`** `number` **Example:** ```json { "data": { "ownBrandMetrics": { "visibilityScore": 1, "sentiment": 1, "mentions": 1, "citations": 1, "avgPosition": 1, "detectionRate": 1, "top3": 1, "validMetricsCount": 1, "trends": { "visibilityScore": 1, "sentiment": 1, "mentions": 1, "citations": 1, "avgPosition": 1, "detectionRate": 1, "top3": 1 }, "historicalData": { "hourly": { "visibilityScore": [ 1 ], "sentiment": [ 1 ], "mentions": [ 1 ], "citations": [ 1 ], "avgPosition": [ 1 ], "detectionRate": [ 1 ], "top3": [ 1 ], "timestamps": [ "" ], "brandNotFound": [ true ] }, "daily": { "visibilityScore": [ 1 ], "sentiment": [ 1 ], "mentions": [ 1 ], "citations": [ 1 ], "avgPosition": [ 1 ], "detectionRate": [ 1 ], "top3": [ 1 ], "timestamps": [ "" ], "brandNotFound": [ true ] }, "weekly": { "visibilityScore": [ 1 ], "sentiment": [ 1 ], "mentions": [ 1 ], "citations": [ 1 ], "avgPosition": [ 1 ], "detectionRate": [ 1 ], "top3": [ 1 ], "timestamps": [ "" ], "brandNotFound": [ true ] }, "monthly": { "visibilityScore": [ 1 ], "sentiment": [ 1 ], "mentions": [ 1 ], "citations": [ 1 ], "avgPosition": [ 1 ], "detectionRate": [ 1 ], "top3": [ 1 ], "timestamps": [ "" ], "brandNotFound": [ true ] } }, "topicMetricsData": { "hourly": [], "daily": [], "weekly": [], "monthly": [ { "topicId": "", "topicName": "", "visibilityScore": [ 1 ], "sentiment": [ 1 ], "avgPosition": [ 1 ], "detectionRate": [ 1 ], "top3": [ 1 ], "mentions": [ 1 ], "citations": [ 1 ], "timestamps": [ "" ], "brandNotFound": [ true ] } ] }, "engineMetricsData": { "hourly": [], "daily": [], "weekly": [], "monthly": [ { "engineId": "", "engineName": "", "visibilityScore": [ 1 ], "sentiment": [ 1 ], "avgPosition": [ 1 ], "detectionRate": [ 1 ], "top3": [ 1 ], "mentions": [ 1 ], "citations": [ 1 ], "timestamps": [ "" ], "brandNotFound": [ true ] } ] }, "preselectionWhitelist": [ "" ], "preselectionBlacklist": [], "manualWhitelist": [], "manualBlacklist": [] }, "competitorMetrics": [ { "name": "", "isOwnBrand": true, "latestValue": 1, "trend": 1, "variations": [ "" ], "visibilityScore": 1, "latestRank": 1, "avgRank": 1, "avgSentiment": 1, "appearances": 1, "citationCount": 1, "detectionRate": 1, "top3": 1, "validMetricsCount": 1 } ], "competitorTimeSeriesData": { "hourly": { "timestamps": [], "competitors": [] }, "daily": { "timestamps": [], "competitors": [] }, "weekly": { "timestamps": [], "competitors": [] }, "monthly": { "timestamps": [ "" ], "competitors": [ { "name": "", "isOwnBrand": true, "variations": [ "" ], "metrics": { "visibilityScore": [ 1 ], "sentiment": [ 1 ], "avgPosition": [ 1 ], "detectionRate": [ 1 ], "top3": [ 1 ], "mentions": [ 1 ], "citations": [ 1 ] } } ] } } } } ``` ### Fetch Sentiment analytics - **Method:** `GET` - **Path:** `/api/v2/ai-visibility/domains/{domain_id}/metrics/sentiment` - **Tags:** Reporting API # Fetch Sentiment Analytics Get comprehensive sentiment analysis data for a specific domain. This endpoint returns brand and company sentiment aggregates, keyword clouds, and sentiment breakdowns by AI engine. ## Endpoint Overview This endpoint analyzes how your domain is perceived across AI-generated search responses, providing insights into brand sentiment, company reputation, and keyword associations. ## Path Variables - **`domain_id`** (required): The unique identifier for the domain you want to fetch sentiment data for. Use the `{{domain_id}}` variable to reference your target domain. ## Query Parameters ### `topics[]` - **Type**: Array of strings - **Required**: No - **Description**: Filter sentiment data by specific topics or categories. This allows you to narrow down the sentiment analysis to particular areas of interest. - **Example**: `topics[]=Ai Search visibility` - **Usage**: Can be passed multiple times to filter by multiple topics ### `search_terms[]` - **Type**: Array of strings - **Required**: No - **Description**: Analyze sentiment for specific search terms or queries. This helps you understand how sentiment varies across different search contexts. - **Example**: `search_terms[]=How often does Keyword.com show up in AI-generated search responses?` - **Usage**: Can be passed multiple times to analyze sentiment across multiple search terms ## Response Data The response includes the following sentiment analysis components: - **Brand Sentiment Aggregates**: Overall sentiment metrics for your brand across AI responses - **Company Sentiment Aggregates**: Aggregated sentiment data specific to your company mentions - **Keyword Clouds**: Visual representation of frequently associated keywords and their sentiment weights - **Sentiment Breakdowns by Engine**: Detailed sentiment analysis segmented by different AI search engines (e.g., ChatGPT, Perplexity, etc.) ## Authentication This endpoint requires authentication via the `api_token` variable. #### Responses ##### Status: 200 Fetch Sentiment analytics response ###### Content-Type: application/json - **`data`** `object` - **`brandSentiments`** `array` **Items:** - **`avgSentiment`** `number` - **`executionCount`** `integer` - **`hasTrainingData`** `boolean` - **`hasWebGrounding`** `boolean` - **`isOwnBrand`** `boolean` - **`name`** `string` - **`nameVariations`** `array` **Items:** `string` - **`negativeCount`** `integer` - **`negativeKeywords`** `object` - **`can get expensive`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`pricey as your list grows`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`neutralCount`** `integer` - **`neutralKeywords`** `object` - **`good analytics`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`integrates with almost everything`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`positiveCount`** `integer` - **`positiveKeywords`** `object` - **`good templates`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`user-friendly interface`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`sentimentCount`** `integer` - **`totalSentimentScore`** `integer` - **`trainingDataKeywords`** `object` - **`neutral`** `object` - **`basic automation`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`good analytics`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`good for basic needs`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`good templates`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`integrates with almost everything`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`positive`** `object` - **`comprehensive templates`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`excellent drag-and-drop editor`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`generous free plan`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`good templates`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`great templates`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`strong brand recognition`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`user-friendly`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`user-friendly interface`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`very user-friendly interface`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`trainingDataSentimentByEngine`** `object` - **`google_gemini_25`** `object` - **`avg`** `number` - **`count`** `integer` - **`sum`** `integer` - **`webGroundingKeywords`** `object` - **`neutral`** `array` **Items:** - **`positive`** `array` **Items:** - **`webGroundingSentimentByEngine`** `array` **Items:** - **`brandSentimentsBySearchTerm`** `array` **Items:** - **`brandSentiments`** `array` **Items:** - **`avgSentiment`** `number` - **`executionCount`** `integer` - **`hasTrainingData`** `boolean` - **`hasWebGrounding`** `boolean` - **`isOwnBrand`** `boolean` - **`name`** `string` - **`negativeCount`** `integer` - **`negativeKeywords`** `object` - **`can get expensive`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`pricey as your list grows`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`neutralCount`** `integer` - **`neutralKeywords`** `object` - **`good analytics`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`integrates with almost everything`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`positiveCount`** `integer` - **`positiveKeywords`** `object` - **`good templates`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`user-friendly interface`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`sentimentCount`** `integer` - **`totalSentimentScore`** `integer` - **`trainingDataKeywords`** `object` - **`neutral`** `object` - **`basic automation`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`good analytics`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`good for basic needs`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`good templates`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`integrates with almost everything`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`positive`** `object` - **`comprehensive templates`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`excellent drag-and-drop editor`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`generous free plan`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`good templates`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`great templates`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`strong brand recognition`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`user-friendly`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`user-friendly interface`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`very user-friendly interface`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`trainingDataSentimentByEngine`** `object` - **`google_gemini_25`** `object` - **`avg`** `number` - **`count`** `integer` - **`sum`** `integer` - **`webGroundingKeywords`** `object` - **`neutral`** `array` **Items:** - **`positive`** `array` **Items:** - **`webGroundingSentimentByEngine`** `array` **Items:** - **`query`** `string` - **`searchTermId`** `string` - **`companySentiments`** `array` **Items:** - **`avgSentiment`** `number` - **`executionCount`** `integer` - **`hasTrainingData`** `boolean` - **`hasWebGrounding`** `boolean` - **`isOwnBrand`** `boolean` - **`name`** `string` - **`nameVariations`** `array` **Items:** `string` - **`negativeCount`** `integer` - **`negativeKeywords`** `object` - **`fewer advanced features`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`slightly fewer integrations`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`neutralCount`** `integer` - **`neutralKeywords`** `object` - **`balance of features`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`good landing page builder`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`positiveCount`** `integer` - **`positiveKeywords`** `object` - **`great value for money`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`intuitive interface`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`sentimentCount`** `integer` - **`totalSentimentScore`** `integer` - **`trainingDataKeywords`** `object` - **`neutral`** `object` - **`balance of features`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`good landing page builder`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`positive`** `object` - **`excellent automation features`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`excellent value`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`great value for money`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`intuitive builder`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`intuitive interface`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`trainingDataSentimentByEngine`** `object` - **`google_gemini_25`** `object` - **`avg`** `number` - **`count`** `integer` - **`sum`** `integer` - **`webGroundingKeywords`** `object` - **`neutral`** `array` **Items:** - **`positive`** `array` **Items:** - **`webGroundingSentimentByEngine`** `array` **Items:** - **`companySentimentsBySearchTerm`** `array` **Items:** - **`companySentiments`** `array` **Items:** - **`avgSentiment`** `number` - **`executionCount`** `integer` - **`hasTrainingData`** `boolean` - **`hasWebGrounding`** `boolean` - **`isOwnBrand`** `boolean` - **`name`** `string` - **`negativeCount`** `integer` - **`negativeKeywords`** `object` - **`fewer advanced features`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`slightly fewer integrations`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`neutralCount`** `integer` - **`neutralKeywords`** `object` - **`balance of features`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`good landing page builder`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`positiveCount`** `integer` - **`positiveKeywords`** `object` - **`great value for money`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`intuitive interface`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`sentimentCount`** `integer` - **`totalSentimentScore`** `integer` - **`trainingDataKeywords`** `object` - **`neutral`** `object` - **`balance of features`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`good landing page builder`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`positive`** `object` - **`excellent automation features`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`excellent value`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`great value for money`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`intuitive builder`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`intuitive interface`** `object` - **`count`** `integer` - **`executionIds`** `array` **Items:** `string` - **`timestamps`** `array` **Items:** `string` - **`trainingDataSentimentByEngine`** `object` - **`google_gemini_25`** `object` - **`avg`** `number` - **`count`** `integer` - **`sum`** `integer` - **`webGroundingKeywords`** `object` - **`neutral`** `array` **Items:** - **`positive`** `array` **Items:** - **`webGroundingSentimentByEngine`** `array` **Items:** - **`query`** `string` - **`searchTermId`** `string` **Example:** ```json { "data": { "brandSentiments": [ { "name": "", "totalSentimentScore": 1, "sentimentCount": 1, "positiveKeywords": { "user-friendly interface": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "good templates": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "neutralKeywords": { "integrates with almost everything": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "good analytics": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "negativeKeywords": { "can get expensive": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "pricey as your list grows": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "executionCount": 1, "isOwnBrand": true, "avgSentiment": 1, "positiveCount": 1, "neutralCount": 1, "negativeCount": 1, "hasWebGrounding": true, "hasTrainingData": true, "nameVariations": [ "" ], "webGroundingKeywords": { "positive": [], "neutral": [] }, "trainingDataKeywords": { "positive": { "user-friendly interface": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "good templates": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "user-friendly": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "comprehensive templates": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "strong brand recognition": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "very user-friendly interface": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "excellent drag-and-drop editor": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "generous free plan": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "great templates": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "neutral": { "integrates with almost everything": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "good analytics": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "good templates": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "basic automation": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "good for basic needs": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } } }, "webGroundingSentimentByEngine": [], "trainingDataSentimentByEngine": { "google_gemini_25": { "sum": 1, "count": 1, "avg": 1 } } } ], "companySentiments": [ { "name": "", "totalSentimentScore": 1, "sentimentCount": 1, "positiveKeywords": { "intuitive interface": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "great value for money": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "neutralKeywords": { "good landing page builder": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "balance of features": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "negativeKeywords": { "fewer advanced features": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "slightly fewer integrations": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "executionCount": 1, "isOwnBrand": true, "avgSentiment": 1, "positiveCount": 1, "neutralCount": 1, "negativeCount": 1, "hasWebGrounding": true, "hasTrainingData": true, "nameVariations": [ "" ], "webGroundingKeywords": { "positive": [], "neutral": [] }, "trainingDataKeywords": { "positive": { "intuitive interface": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "great value for money": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "excellent automation features": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "excellent value": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "intuitive builder": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "neutral": { "good landing page builder": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "balance of features": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } } }, "webGroundingSentimentByEngine": [], "trainingDataSentimentByEngine": { "google_gemini_25": { "sum": 1, "count": 1, "avg": 1 } } } ], "brandSentimentsBySearchTerm": [ { "searchTermId": "", "query": "", "brandSentiments": [ { "name": "", "isOwnBrand": true, "avgSentiment": 1, "sentimentCount": 1, "totalSentimentScore": 1, "positiveCount": 1, "neutralCount": 1, "negativeCount": 1, "executionCount": 1, "hasWebGrounding": true, "hasTrainingData": true, "positiveKeywords": { "user-friendly interface": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "good templates": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "neutralKeywords": { "integrates with almost everything": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "good analytics": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "negativeKeywords": { "can get expensive": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "pricey as your list grows": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "webGroundingKeywords": { "positive": [], "neutral": [] }, "trainingDataKeywords": { "positive": { "user-friendly interface": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "good templates": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "user-friendly": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "comprehensive templates": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "strong brand recognition": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "very user-friendly interface": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "excellent drag-and-drop editor": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "generous free plan": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "great templates": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "neutral": { "integrates with almost everything": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "good analytics": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "good templates": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "basic automation": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "good for basic needs": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } } }, "webGroundingSentimentByEngine": [], "trainingDataSentimentByEngine": { "google_gemini_25": { "sum": 1, "count": 1, "avg": 1 } } } ] } ], "companySentimentsBySearchTerm": [ { "searchTermId": "", "query": "", "companySentiments": [ { "name": "", "isOwnBrand": true, "avgSentiment": 1, "sentimentCount": 1, "totalSentimentScore": 1, "positiveCount": 1, "neutralCount": 1, "negativeCount": 1, "executionCount": 1, "hasWebGrounding": true, "hasTrainingData": true, "positiveKeywords": { "intuitive interface": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "great value for money": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "neutralKeywords": { "good landing page builder": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "balance of features": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "negativeKeywords": { "fewer advanced features": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "slightly fewer integrations": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "webGroundingKeywords": { "positive": [], "neutral": [] }, "trainingDataKeywords": { "positive": { "intuitive interface": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "great value for money": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "excellent automation features": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "excellent value": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "intuitive builder": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } }, "neutral": { "good landing page builder": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] }, "balance of features": { "count": 1, "executionIds": [ "" ], "timestamps": [ "" ] } } }, "webGroundingSentimentByEngine": [], "trainingDataSentimentByEngine": { "google_gemini_25": { "sum": 1, "count": 1, "avg": 1 } } } ] } ] } } ``` ### Fetch Citation analytics - **Method:** `GET` - **Path:** `/api/v2/ai-visibility/domains/{domain_id}/metrics/citations` - **Tags:** Reporting API # Fetch Citation Analytics Get comprehensive citation analytics for a domain, including detailed breakdowns of how the domain appears in AI-generated search responses. ## Overview This endpoint retrieves citation data for a specified domain, providing insights into: - **Domain aggregations**: Overall citation metrics at the domain level - **URL aggregations**: Citation metrics broken down by individual URLs - **Citation breakdowns by AI engine**: How different AI search engines cite your domain - **Citation breakdowns by query**: Which search queries trigger citations of your domain - **Brand analysis**: Citation performance for your brand - **Competitor analysis**: Comparative citation data against competitors ## Path Variables - **`{{domain_id}}`** (required): The unique identifier for the domain you want to fetch citation analytics for ## Query Parameters All query parameters are optional and can be used to filter and refine the citation data: - **`topics[]`**: Filter citation data by specific topics - Type: Array of strings - Example: `topics[]=Ai Search visibility` - Use this to focus on citations related to particular subject areas or themes - **`search_terms[]`**: Analyze citations for specific search terms or queries - Type: Array of strings - Example: `search_terms[]=How often does Keyword.com show up in AI-generated search responses?` - Use this to understand how your domain is cited when users search for particular terms ## Response The response includes comprehensive citation analytics with domain and URL level aggregations, breakdowns by AI engine, query-specific citation data, brand performance metrics, and competitor comparison data. #### Responses ##### Status: 200 Fetch Citation analytics response ###### Content-Type: application/json - **`data`** `object` - **`citationsByDomain`** `array` **Items:** - **`citations`** `array` **Items:** - **`brands`** `array` **Items:** - **`category`** `string` - **`counts`** `object` - **`2026-04-03`** `integer` - **`2026-04-10`** `integer` - **`countsGranularity`** `string` - **`firstSeenAt`** `string` - **`lastSeenAt`** `string` - **`normalizedUrl`** `string` - **`occurrences`** `integer` - **`searchTerms`** `array` **Items:** - **`engine`** `string` - **`id`** `string` - **`query`** `string` - **`region`** `string` - **`urlOccurrences`** `integer` - **`url`** `string` - **`domain`** `string` - **`occurrences`** `integer` - **`domainSummary`** `object` - **`topDomainsByCompetitor`** `array` **Items:** - **`topDomainsByEngine`** `array` **Items:** - **`domains`** `array` **Items:** - **`domain`** `string` - **`occurrences`** `integer` - **`urls`** `array` **Items:** - **`occurrences`** `integer` - **`url`** `string` - **`engineId`** `string` - **`topDomainsByOwnBrandCitations`** `array` **Items:** - **`topDomainsByQuery`** `array` **Items:** - **`engines`** `array` **Items:** - **`domains`** `array` **Items:** - **`domain`** `string` - **`occurrences`** `integer` - **`urls`** `array` **Items:** - **`occurrences`** `integer` - **`url`** `string` - **`engineId`** `string` - **`query`** `string` - **`searchTermIds`** `array` **Items:** `string` - **`topDomainsOverall`** `array` **Items:** - **`domain`** `string` - **`occurrences`** `integer` - **`urls`** `array` **Items:** - **`occurrences`** `integer` - **`url`** `string` - **`paginationInfo`** `object` - **`brandsCapped`** `boolean` - **`citationsCapped`** `boolean` - **`hasMore`** `boolean` - **`maxBrands`** `integer` - **`maxCitations`** `integer` - **`returnedCount`** `integer` - **`totalCount`** `integer` - **`timestampFormat`** `string` - **`totalBrands`** `integer` - **`totalCitations`** `integer` - **`uniqueCitations`** `integer` - **`uniqueDomains`** `integer` **Example:** ```json { "data": { "totalCitations": 1, "uniqueCitations": 1, "uniqueDomains": 1, "totalBrands": 1, "timestampFormat": "", "paginationInfo": { "hasMore": true, "totalCount": 1, "returnedCount": 1, "citationsCapped": true, "brandsCapped": true, "maxCitations": 1, "maxBrands": 1 }, "domainSummary": { "topDomainsOverall": [ { "domain": "", "occurrences": 1, "urls": [ { "url": "", "occurrences": 1 } ] } ], "topDomainsByEngine": [ { "engineId": "", "domains": [ { "domain": "", "occurrences": 1, "urls": [ { "url": "", "occurrences": 1 } ] } ] } ], "topDomainsByQuery": [ { "query": "", "searchTermIds": [ "" ], "engines": [ { "engineId": "", "domains": [ { "domain": "", "occurrences": 1, "urls": [ { "url": "[Max Depth Exceeded]", "occurrences": "[Max Depth Exceeded]" } ] } ] } ] } ], "topDomainsByOwnBrandCitations": [], "topDomainsByCompetitor": [] }, "citationsByDomain": [ { "domain": "", "occurrences": 1, "citations": [ { "url": "", "normalizedUrl": "", "occurrences": 1, "firstSeenAt": "", "lastSeenAt": "", "category": "", "searchTerms": [ { "id": "", "query": "", "engine": "", "region": "", "urlOccurrences": 1 } ], "brands": [], "counts": { "2026-04-03": 1, "2026-04-10": 1 }, "countsGranularity": "" } ] } ] } } ```