# Citations

## List Citations

> Citations (URLs) with detailed metrics including influence score. Shows individual URLs being cited in AI answers with page-level context.

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"tags":[{"name":"Citations"}],"servers":[{"url":"https://api.airops.com","variables":{"defaultHost":{"default":"api.airops.com"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/public_api/brand_kits/{brand_kit_id}/citations/list":{"post":{"summary":"List Citations","description":"Citations (URLs) with detailed metrics including influence score. Shows individual URLs being cited in AI answers with page-level context.","tags":["Citations"],"operationId":"listBrandKitsCitations","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"url":{"nullable":true,"type":"string","description":"The cited URL"},"domain":{"nullable":true,"type":"integer","description":"Domain ID"},"domain_name":{"nullable":true,"type":"string","description":"Name of the domain"},"domain_category":{"nullable":true,"type":"string","description":"Category: Owned, Competitors, Social, etc."},"logo_url":{"nullable":true,"type":"string","description":"URL to the domain logo"},"citation_count":{"nullable":true,"type":"integer","description":"Total number of citations for this URL"},"citation_count_trend":{"nullable":true,"type":"integer","description":"Change in citation count vs previous period"},"citation_share":{"nullable":true,"type":"number","description":"Percentage of total citations (0-100)"},"citation_share_trend":{"nullable":true,"type":"number","description":"Change in citation share vs previous period"},"citation_rate":{"nullable":true,"type":"number","description":"Percentage of answers citing this URL (0-100)"},"citation_rate_trend":{"nullable":true,"type":"number","description":"Change in citation rate vs previous period"},"influence_score":{"nullable":true,"type":"integer","description":"Overall influence score (0-100)"},"influence_score_breakdown":{"nullable":true,"type":"object","description":"Breakdown: coverage_score, impact_score, da_score"},"page_type":{"nullable":true,"type":"string","description":"Type of page","enum":["homepage","product_page","collection_page","pricing_page","informational_article","documentation","listicle_article","comparison_page","support_article","review_page","forum_thread","social_media_post","video_page","news_article","case_study","marketplace_listing","landing_page","deal_page","other",null]},"brand_mentioned":{"nullable":true,"type":"boolean","description":"Whether brand is mentioned on the page"},"brand_sentiment":{"nullable":true,"type":"string","description":"Sentiment toward brand on the page","enum":["negative","neutral","positive",null]},"mentioned_competitor_domains":{"nullable":true,"type":"array","items":{"type":"object"},"description":"Competitors mentioned on the page"},"domain_authority":{"nullable":true,"type":"integer","description":"Domain authority score"}}}},"meta":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"data_availability":{"type":"object","description":"Information about data availability for the brand kit","properties":{"earliest_data_date":{"nullable":true,"type":"string","description":"Date of the first completed analysis (ISO 8601). Null if none exist."},"latest_data_date":{"nullable":true,"type":"string","description":"Date of the most recent completed analysis (ISO 8601). Null if none exist."},"requested_period_has_data":{"type":"boolean","description":"Whether any completed analyses exist within the requested date range"}}}}}},"required":["data","meta"]}}}},"400":{"description":"Bad request - invalid parameters, filters, or sort options"},"401":{"description":"Unauthorized - invalid or missing authentication token"},"404":{"description":"Not found - resource does not exist"},"412":{"description":"Precondition failed - AEO not configured for this brand kit"}},"parameters":[{"name":"brand_kit_id","in":"path","required":true,"schema":{"type":"integer"},"description":"The Brand Kit ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"brand_kit_id":{"type":"integer","description":"The ID of the Brand Kit"},"start_date":{"type":"string","description":"Start date for metrics (ISO 8601). Defaults to 1 month ago."},"end_date":{"type":"string","description":"End date for metrics (ISO 8601). Defaults to today."},"providers":{"type":"array","description":"Filter metrics by AI providers","items":{"type":"string","enum":["chat_gpt","gemini","perplexity","google_ai_mode","google_ai_overview","claude","grok","microsoft_copilot"]}},"countries":{"type":"array","description":"Filter metrics by country codes","items":{"type":"string","enum":["AE","AR","AT","AU","BE","BR","CA","CH","CL","CN","CO","CZ","DE","DK","ES","FI","FR","GB","GR","HR","HU","ID","IE","IL","IN","IS","IT","JP","KR","MX","MY","NL","NO","NZ","PE","PH","PL","PT","SE","SG","TH","TR","US","VN"]}},"personas":{"type":"array","description":"Filter metrics by persona IDs","items":{"type":"integer"}},"filters":{"type":"array","description":"Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`.\n\n**Available fields:**\n- **domain_category** (EQUALS, IN): Filter by domain category\n- **domain_id** (EQ): Filter by specific domain ID\n- **topic_id** (EQ, IN): Filter by topic ID\n- **brand_mentioned** (EQUALS): Filter by query type: brand or category\n- **page_type** (EQUALS): Filter by page type\n- **brand_referenced** (EQ): Filter by whether brand is referenced on the citing page\n- **brand_sentiment** (EQUALS): Filter by brand sentiment\n- **mentioned_competitor_domains** (IN): Filter by competitor domain IDs mentioned on the citing page\n- **url** (CONTAINS): Filter by case-insensitive substring match on the citation URL. Matches against the normalized URL (without scheme or www).","items":{"type":"object","properties":{"field":{"type":"string","enum":["domain_category","domain_id","topic_id","brand_mentioned","page_type","brand_referenced","brand_sentiment","mentioned_competitor_domains","url"],"description":"Field to filter on. domain_category: Filter by domain category (values: Social, Communities, Reviews, Media, Educational, Marketplaces, Products, Affiliates, Other, Owned, Competitors, No Category); domain_id: Filter by specific domain ID; topic_id: Filter by topic ID; brand_mentioned: Filter by query type: brand or category (values: brand, category); page_type: Filter by page type (values: homepage, product_page, collection_page, pricing_page, informational_article, documentation, listicle_article, comparison_page, support_article, review_page, forum_thread, social_media_post, video_page, news_article, case_study, marketplace_listing, landing_page, deal_page, other); brand_referenced: Filter by whether brand is referenced on the citing page; brand_sentiment: Filter by brand sentiment (values: negative, neutral, positive); mentioned_competitor_domains: Filter by competitor domain IDs mentioned on the citing page; url: Filter by case-insensitive substring match on the citation URL. Matches against the normalized URL (without scheme or www)."},"operator":{"type":"string","enum":["EQUALS","IN","EQ","CONTAINS"],"description":"Filter operator.\n\n- **EQ/EQUALS**: Exact match\n- **NEQ**: Not equal\n- **GT/GEQ/LT/LEQ**: Numeric/date comparisons\n- **CONTAINS**: Partial text match\n- **STARTS_WITH**: Text prefix match\n- **IN**: Match any value in array"},"value":{"description":"Filter value (type depends on field and operator)"}},"required":["field","operator","value"]}},"fields":{"type":"array","description":"Select additional fields to return.\n\n**Optional fields:**\n- **url**: The cited URL\n- **domain**: Domain ID\n- **domain_name**: Name of the domain\n- **domain_category**: Category: Owned, Competitors, Social, etc.\n- **logo_url**: URL to the domain logo\n- **citation_count**: Total number of citations for this URL\n- **citation_count_trend**: Change in citation count vs previous period\n- **citation_share**: Percentage of total citations (0-100)\n- **citation_share_trend**: Change in citation share vs previous period\n- **citation_rate**: Percentage of answers citing this URL (0-100)\n- **citation_rate_trend**: Change in citation rate vs previous period\n- **influence_score**: Overall influence score (0-100)\n- **influence_score_breakdown**: Breakdown: coverage_score, impact_score, da_score\n- **page_type**: Type of page\n- **brand_mentioned**: Whether brand is mentioned on the page\n- **brand_sentiment**: Sentiment toward brand on the page\n- **mentioned_competitor_domains**: Competitors mentioned on the page\n- **domain_authority**: Domain authority score","items":{"type":"string","enum":["url","domain","domain_name","domain_category","logo_url","citation_count","citation_count_trend","citation_share","citation_share_trend","citation_rate","citation_rate_trend","influence_score","influence_score_breakdown","page_type","brand_mentioned","brand_sentiment","mentioned_competitor_domains","domain_authority"]}},"sort":{"type":"string","enum":["citation_count","-citation_count","citation_share","-citation_share","citation_rate","-citation_rate","influence_score","-influence_score"],"description":"Sort field. Prefix with - for descending.\n\n**Available sort fields:**\n- **citation_count/-citation_count**: Sort by citation count\n- **citation_share/-citation_share**: Sort by citation share percentage\n- **citation_rate/-citation_rate**: Sort by citation rate percentage\n- **influence_score/-influence_score**: Sort by influence score"},"page":{"type":"integer","default":1,"description":"Page number"},"per_page":{"type":"integer","default":25,"maximum":100,"description":"Items per page"}},"required":["brand_kit_id"]}}}}}}}}
```

## Get Citation

> Citations (URLs) with detailed metrics including influence score. Shows individual URLs being cited in AI answers with page-level context.

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"tags":[{"name":"Citations"}],"servers":[{"url":"https://api.airops.com","variables":{"defaultHost":{"default":"api.airops.com"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/public_api/brand_kits/{brand_kit_id}/citations/show":{"post":{"summary":"Get Citation","description":"Citations (URLs) with detailed metrics including influence score. Shows individual URLs being cited in AI answers with page-level context.","tags":["Citations"],"operationId":"getBrandKitsCitation","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"url":{"nullable":true,"type":"string","description":"The cited URL"},"domain":{"nullable":true,"type":"integer","description":"Domain ID"},"domain_name":{"nullable":true,"type":"string","description":"Name of the domain"},"domain_category":{"nullable":true,"type":"string","description":"Category: Owned, Competitors, Social, etc."},"logo_url":{"nullable":true,"type":"string","description":"URL to the domain logo"},"citation_count":{"nullable":true,"type":"integer","description":"Total number of citations for this URL"},"citation_count_trend":{"nullable":true,"type":"integer","description":"Change in citation count vs previous period"},"citation_share":{"nullable":true,"type":"number","description":"Percentage of total citations (0-100)"},"citation_share_trend":{"nullable":true,"type":"number","description":"Change in citation share vs previous period"},"citation_rate":{"nullable":true,"type":"number","description":"Percentage of answers citing this URL (0-100)"},"citation_rate_trend":{"nullable":true,"type":"number","description":"Change in citation rate vs previous period"},"influence_score":{"nullable":true,"type":"integer","description":"Overall influence score (0-100)"},"influence_score_breakdown":{"nullable":true,"type":"object","description":"Breakdown: coverage_score, impact_score, da_score"},"page_type":{"nullable":true,"type":"string","description":"Type of page","enum":["homepage","product_page","collection_page","pricing_page","informational_article","documentation","listicle_article","comparison_page","support_article","review_page","forum_thread","social_media_post","video_page","news_article","case_study","marketplace_listing","landing_page","deal_page","other",null]},"brand_mentioned":{"nullable":true,"type":"boolean","description":"Whether brand is mentioned on the page"},"brand_sentiment":{"nullable":true,"type":"string","description":"Sentiment toward brand on the page","enum":["negative","neutral","positive",null]},"mentioned_competitor_domains":{"nullable":true,"type":"array","items":{"type":"object"},"description":"Competitors mentioned on the page"},"domain_authority":{"nullable":true,"type":"integer","description":"Domain authority score"}}}},"required":["data"]}}}},"400":{"description":"Bad request - invalid parameters, filters, or sort options"},"401":{"description":"Unauthorized - invalid or missing authentication token"},"404":{"description":"Not found - resource does not exist"},"412":{"description":"Precondition failed - AEO not configured for this brand kit"}},"parameters":[{"name":"brand_kit_id","in":"path","required":true,"schema":{"type":"integer"},"description":"The Brand Kit ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"brand_kit_id":{"type":"integer","description":"The ID of the Brand Kit"},"start_date":{"type":"string","description":"Start date for metrics (ISO 8601). Defaults to 1 month ago."},"end_date":{"type":"string","description":"End date for metrics (ISO 8601). Defaults to today."},"providers":{"type":"array","description":"Filter metrics by AI providers","items":{"type":"string","enum":["chat_gpt","gemini","perplexity","google_ai_mode","google_ai_overview","claude","grok","microsoft_copilot"]}},"countries":{"type":"array","description":"Filter metrics by country codes","items":{"type":"string","enum":["AE","AR","AT","AU","BE","BR","CA","CH","CL","CN","CO","CZ","DE","DK","ES","FI","FR","GB","GR","HR","HU","ID","IE","IL","IN","IS","IT","JP","KR","MX","MY","NL","NO","NZ","PE","PH","PL","PT","SE","SG","TH","TR","US","VN"]}},"personas":{"type":"array","description":"Filter metrics by persona IDs","items":{"type":"integer"}},"id":{"type":"integer","description":"Resource ID"},"filters":{"type":"array","description":"Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`.\n\n**Available fields:**\n- **domain_category** (EQUALS, IN): Filter by domain category\n- **domain_id** (EQ): Filter by specific domain ID\n- **topic_id** (EQ, IN): Filter by topic ID\n- **brand_mentioned** (EQUALS): Filter by query type: brand or category\n- **page_type** (EQUALS): Filter by page type\n- **brand_referenced** (EQ): Filter by whether brand is referenced on the citing page\n- **brand_sentiment** (EQUALS): Filter by brand sentiment\n- **mentioned_competitor_domains** (IN): Filter by competitor domain IDs mentioned on the citing page\n- **url** (CONTAINS): Filter by case-insensitive substring match on the citation URL. Matches against the normalized URL (without scheme or www).","items":{"type":"object","properties":{"field":{"type":"string","enum":["domain_category","domain_id","topic_id","brand_mentioned","page_type","brand_referenced","brand_sentiment","mentioned_competitor_domains","url"],"description":"Field to filter on. domain_category: Filter by domain category (values: Social, Communities, Reviews, Media, Educational, Marketplaces, Products, Affiliates, Other, Owned, Competitors, No Category); domain_id: Filter by specific domain ID; topic_id: Filter by topic ID; brand_mentioned: Filter by query type: brand or category (values: brand, category); page_type: Filter by page type (values: homepage, product_page, collection_page, pricing_page, informational_article, documentation, listicle_article, comparison_page, support_article, review_page, forum_thread, social_media_post, video_page, news_article, case_study, marketplace_listing, landing_page, deal_page, other); brand_referenced: Filter by whether brand is referenced on the citing page; brand_sentiment: Filter by brand sentiment (values: negative, neutral, positive); mentioned_competitor_domains: Filter by competitor domain IDs mentioned on the citing page; url: Filter by case-insensitive substring match on the citation URL. Matches against the normalized URL (without scheme or www)."},"operator":{"type":"string","enum":["EQUALS","IN","EQ","CONTAINS"],"description":"Filter operator.\n\n- **EQ/EQUALS**: Exact match\n- **NEQ**: Not equal\n- **GT/GEQ/LT/LEQ**: Numeric/date comparisons\n- **CONTAINS**: Partial text match\n- **STARTS_WITH**: Text prefix match\n- **IN**: Match any value in array"},"value":{"description":"Filter value (type depends on field and operator)"}},"required":["field","operator","value"]}},"fields":{"type":"array","description":"Select specific fields to return.\n\n**Available fields:**\n- **url**: The cited URL\n- **domain**: Domain ID\n- **domain_name**: Name of the domain\n- **domain_category**: Category: Owned, Competitors, Social, etc.\n- **logo_url**: URL to the domain logo\n- **citation_count**: Total number of citations for this URL\n- **citation_count_trend**: Change in citation count vs previous period\n- **citation_share**: Percentage of total citations (0-100)\n- **citation_share_trend**: Change in citation share vs previous period\n- **citation_rate**: Percentage of answers citing this URL (0-100)\n- **citation_rate_trend**: Change in citation rate vs previous period\n- **influence_score**: Overall influence score (0-100)\n- **influence_score_breakdown**: Breakdown: coverage_score, impact_score, da_score\n- **page_type**: Type of page\n- **brand_mentioned**: Whether brand is mentioned on the page\n- **brand_sentiment**: Sentiment toward brand on the page\n- **mentioned_competitor_domains**: Competitors mentioned on the page\n- **domain_authority**: Domain authority score","items":{"type":"string","enum":["url","domain","domain_name","domain_category","logo_url","citation_count","citation_count_trend","citation_share","citation_share_trend","citation_rate","citation_rate_trend","influence_score","influence_score_breakdown","page_type","brand_mentioned","brand_sentiment","mentioned_competitor_domains","domain_authority"]}}},"required":["brand_kit_id","id"]}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.airops.com/api-reference/api-reference/brand-kits/citations.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.