> For the complete documentation index, see [llms.txt](https://docs.airops.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.airops.com/api-reference-1/brand-kits/citations.md).

# 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":"citation_rate = answers citing this URL ÷ answers in scope (0-100). Answer filters (providers, countries, personas, topics, tags, prompt_type) narrow the scope. Filters on the cited source (domain, domain_category, url, page_type, brand_mentioned, brand_sentiment) only narrow which rows are returned and don't change the rate."},"citation_rate_trend":{"nullable":true,"type":"number","description":"Change in citation_rate vs previous period (current − comparison), each over its own period's answers in scope."},"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"},"social":{"nullable":true,"type":"object","description":"Platform-neutral social content and account enrichment"},"first_cited":{"nullable":true,"type":"string","description":"Optional citation decay: First observed citation date within the selected period (YYYY-MM-DD)."},"last_cited":{"nullable":true,"type":"string","description":"Optional citation decay: Last observed citation date within the selected period (YYYY-MM-DD)."},"peak_week":{"nullable":true,"type":"string","description":"Optional citation decay: Monday of the earliest highest-citation week in the selected period."},"rise_days":{"nullable":true,"type":"integer","description":"Optional citation decay: Days from first observed citation to peak week, with a minimum of zero."},"rise_weeks":{"nullable":true,"type":"number","description":"Optional citation decay: Rise days divided by seven; may be fractional."},"decline_absolute":{"nullable":true,"type":"integer","description":"Optional citation decay: Peak weekly count minus latest full-week count; null without a full week."},"decline_pct":{"nullable":true,"type":"number","description":"Optional citation decay: Decline as a percentage of peak weekly count (0-100); null without a full week."},"decline_week":{"nullable":true,"type":"string","description":"Optional citation decay: Monday of the latest full week used for decline; null without a full week."},"half_life_week":{"nullable":true,"type":"string","description":"Optional citation decay: First post-peak week with sustained halving of the two-week average; null if absent."},"half_life_days":{"nullable":true,"type":"integer","description":"Optional citation decay: Days from peak week to sustained halving; null if not reached."}}}},"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"},"tags":{"type":"object","description":"Filter by tags. Object form { \"operator\": \"IN\" | \"HAS_ALL\" | \"NOT_IN\", \"value\": [tag ids] }. IN matches items tagged with ANY of the tags; HAS_ALL matches only items tagged with ALL; NOT_IN matches only items tagged with NONE.","properties":{"operator":{"type":"string","description":"IN matches items tagged with ANY of the tags; HAS_ALL matches only items tagged with ALL of them; NOT_IN matches only items tagged with NONE of them.","enum":["IN","HAS_ALL","NOT_IN"]},"value":{"type":"array","description":"Tag IDs to filter by.","items":{"type":"integer"}}},"required":["operator","value"],"additionalProperties":false},"start_date":{"type":"string","description":"Start date for metrics (ISO 8601). Defaults to 1 month before the end date."},"end_date":{"type":"string","description":"End date for metrics (ISO 8601). Defaults to the latest analysis date, or today when a start date is provided or no analysis exists."},"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","claude_code","codex","muse_spark"]}},"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","KE","KR","MX","MY","NG","NL","NO","NZ","PE","PH","PL","PT","SA","SE","SG","TH","TR","TW","US","VN","ZA"]}},"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- **prompt_type** (EQUALS): Filter by prompt type. Use operator EQUALS with value 'brand' (prompts that name the brand) or 'category' (prompts that do not). Narrows the citation_rate scope (answers in scope).\n- **peak_week** (EQ, NEQ, GT, LT, GEQ, LEQ): Monday of the earliest highest-citation week in the selected period.\n- **rise_days** (EQ, NEQ, GT, LT, GEQ, LEQ): Days from first observed citation to peak week, with a minimum of zero.\n- **rise_weeks** (EQ, NEQ, GT, LT, GEQ, LEQ): Rise days divided by seven; may be fractional.\n- **decline_absolute** (EQ, NEQ, GT, LT, GEQ, LEQ, IS_NULL, IS_NOT_NULL): Peak weekly count minus latest full-week count; null without a full week.\n- **decline_pct** (EQ, NEQ, GT, LT, GEQ, LEQ, IS_NULL, IS_NOT_NULL): Decline as a percentage of peak weekly count (0-100); null without a full week.\n- **half_life_days** (EQ, NEQ, GT, LT, GEQ, LEQ, IS_NULL, IS_NOT_NULL): Days from peak week to sustained halving; null if not reached.\n- **half_life_week** (EQ, NEQ, GT, LT, GEQ, LEQ, IS_NULL, IS_NOT_NULL): First post-peak week with sustained halving of the two-week average; null if absent.\n- **first_cited** (EQ, NEQ, GT, LT, GEQ, LEQ): First observed citation date within the selected period (YYYY-MM-DD).\n- **last_cited** (EQ, NEQ, GT, LT, GEQ, LEQ): Last observed citation date within the selected period (YYYY-MM-DD).\n- **domain_category** (EQUALS, IN): Filter by domain category\n- **domain_id** (EQ, IN): Filter by domain ID\n- **topic_id** (EQ, IN): Filter by topic ID\n- **brand_mentioned** (EQ, EQUALS): Filter by whether the citing page mentions the brand (the brand_mentioned output field). Use operator EQ with value true or false — this is a source filter and does not change citation_rate. Deprecated: EQUALS with 'brand' or 'category' is a prompt_type filter and does narrow the citation_rate scope; use prompt_type instead.\n- **page_type** (EQUALS): Filter by page type (source filter; does not change citation_rate)\n- **brand_referenced** (EQ): Deprecated: use brand_mentioned with operator EQ and value true or false.\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** (EQUALS, CONTAINS): EQUALS matches the normalized URL exactly (most query parameters and fragments removed; YouTube v and Google Play id retained). Scheme, www, and case matter. CONTAINS finds a case-insensitive literal substring.","items":{"type":"object","properties":{"field":{"type":"string","enum":["prompt_type","peak_week","rise_days","rise_weeks","decline_absolute","decline_pct","half_life_days","half_life_week","first_cited","last_cited","domain_category","domain_id","topic_id","brand_mentioned","page_type","brand_referenced","brand_sentiment","mentioned_competitor_domains","url"],"description":"Field to filter on. prompt_type: Filter by prompt type. Use operator EQUALS with value 'brand' (prompts that name the brand) or 'category' (prompts that do not). Narrows the citation_rate scope (answers in scope). (values: brand, category); peak_week: Monday of the earliest highest-citation week in the selected period.; rise_days: Days from first observed citation to peak week, with a minimum of zero.; rise_weeks: Rise days divided by seven; may be fractional.; decline_absolute: Peak weekly count minus latest full-week count; null without a full week.; decline_pct: Decline as a percentage of peak weekly count (0-100); null without a full week.; half_life_days: Days from peak week to sustained halving; null if not reached.; half_life_week: First post-peak week with sustained halving of the two-week average; null if absent.; first_cited: First observed citation date within the selected period (YYYY-MM-DD).; last_cited: Last observed citation date within the selected period (YYYY-MM-DD).; domain_category: Filter by domain category (values: Social, Communities, Reviews, Media, Educational, Marketplaces, Products, Affiliates, Other, Owned, Competitors, No Category); domain_id: Filter by domain ID; topic_id: Filter by topic ID; brand_mentioned: Filter by whether the citing page mentions the brand (the brand_mentioned output field). Use operator EQ with value true or false — this is a source filter and does not change citation_rate. Deprecated: EQUALS with 'brand' or 'category' is a prompt_type filter and does narrow the citation_rate scope; use prompt_type instead.; page_type: Filter by page type (source filter; does not change citation_rate) (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: Deprecated: use brand_mentioned with operator EQ and value true or false.; brand_sentiment: Filter by brand sentiment (values: negative, neutral, positive); mentioned_competitor_domains: Filter by competitor domain IDs mentioned on the citing page; url: EQUALS matches the normalized URL exactly (most query parameters and fragments removed; YouTube v and Google Play id retained). Scheme, www, and case matter. CONTAINS finds a case-insensitive literal substring."},"operator":{"type":"string","enum":["EQUALS","EQ","NEQ","GT","LT","GEQ","LEQ","IS_NULL","IS_NOT_NULL","IN","CONTAINS"],"description":"Use an operator listed for the selected field in the filters description."},"value":{"description":"Filter value (type depends on field and operator)"}},"required":["field","operator","value"],"additionalProperties":false}},"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**: citation_rate = answers citing this URL ÷ answers in scope (0-100). Answer filters (providers, countries, personas, topics, tags, prompt_type) narrow the scope. Filters on the cited source (domain, domain_category, url, page_type, brand_mentioned, brand_sentiment) only narrow which rows are returned and don't change the rate.\n- **citation_rate_trend**: Change in citation_rate vs previous period (current − comparison), each over its own period's answers in scope.\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\n- **social**: Platform-neutral social content and account enrichment\n- **first_cited**: Optional citation decay: First observed citation date within the selected period (YYYY-MM-DD).\n- **last_cited**: Optional citation decay: Last observed citation date within the selected period (YYYY-MM-DD).\n- **peak_week**: Optional citation decay: Monday of the earliest highest-citation week in the selected period.\n- **rise_days**: Optional citation decay: Days from first observed citation to peak week, with a minimum of zero.\n- **rise_weeks**: Optional citation decay: Rise days divided by seven; may be fractional.\n- **decline_absolute**: Optional citation decay: Peak weekly count minus latest full-week count; null without a full week.\n- **decline_pct**: Optional citation decay: Decline as a percentage of peak weekly count (0-100); null without a full week.\n- **decline_week**: Optional citation decay: Monday of the latest full week used for decline; null without a full week.\n- **half_life_week**: Optional citation decay: First post-peak week with sustained halving of the two-week average; null if absent.\n- **half_life_days**: Optional citation decay: Days from peak week to sustained halving; null if not reached.","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","social","first_cited","last_cited","peak_week","rise_days","rise_weeks","decline_absolute","decline_pct","decline_week","half_life_week","half_life_days"]}},"sort":{"type":"string","enum":["first_cited","-first_cited","last_cited","-last_cited","peak_week","-peak_week","rise_days","-rise_days","rise_weeks","-rise_weeks","decline_absolute","-decline_absolute","decline_pct","-decline_pct","decline_week","-decline_week","half_life_week","-half_life_week","half_life_days","-half_life_days","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- **first_cited/-first_cited**: Sort by first_cited within the selected period\n- **last_cited/-last_cited**: Sort by last_cited within the selected period\n- **peak_week/-peak_week**: Sort by peak_week within the selected period\n- **rise_days/-rise_days**: Sort by rise_days within the selected period\n- **rise_weeks/-rise_weeks**: Sort by rise_weeks within the selected period\n- **decline_absolute/-decline_absolute**: Sort by decline_absolute within the selected period\n- **decline_pct/-decline_pct**: Sort by decline_pct within the selected period\n- **decline_week/-decline_week**: Sort by decline_week within the selected period\n- **half_life_week/-half_life_week**: Sort by half_life_week within the selected period\n- **half_life_days/-half_life_days**: Sort by half_life_days within the selected period\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"},"auth_token":{"type":"string","description":"API authentication token"}},"required":["brand_kit_id"],"additionalProperties":false}}}}}}}}
```

## 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":"citation_rate = answers citing this URL ÷ answers in scope (0-100). Answer filters (providers, countries, personas, topics, tags, prompt_type) narrow the scope. Filters on the cited source (domain, domain_category, url, page_type, brand_mentioned, brand_sentiment) only narrow which rows are returned and don't change the rate."},"citation_rate_trend":{"nullable":true,"type":"number","description":"Change in citation_rate vs previous period (current − comparison), each over its own period's answers in scope."},"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"},"social":{"nullable":true,"type":"object","description":"Platform-neutral social content and account enrichment"},"first_cited":{"nullable":true,"type":"string","description":"Optional citation decay: First observed citation date within the selected period (YYYY-MM-DD)."},"last_cited":{"nullable":true,"type":"string","description":"Optional citation decay: Last observed citation date within the selected period (YYYY-MM-DD)."},"peak_week":{"nullable":true,"type":"string","description":"Optional citation decay: Monday of the earliest highest-citation week in the selected period."},"rise_days":{"nullable":true,"type":"integer","description":"Optional citation decay: Days from first observed citation to peak week, with a minimum of zero."},"rise_weeks":{"nullable":true,"type":"number","description":"Optional citation decay: Rise days divided by seven; may be fractional."},"decline_absolute":{"nullable":true,"type":"integer","description":"Optional citation decay: Peak weekly count minus latest full-week count; null without a full week."},"decline_pct":{"nullable":true,"type":"number","description":"Optional citation decay: Decline as a percentage of peak weekly count (0-100); null without a full week."},"decline_week":{"nullable":true,"type":"string","description":"Optional citation decay: Monday of the latest full week used for decline; null without a full week."},"half_life_week":{"nullable":true,"type":"string","description":"Optional citation decay: First post-peak week with sustained halving of the two-week average; null if absent."},"half_life_days":{"nullable":true,"type":"integer","description":"Optional citation decay: Days from peak week to sustained halving; null if not reached."},"prompts":{"type":"array","items":{"type":"object"}},"weekly_series":{"type":"array","description":"Weekly citation counts in the selected period and scope, starting at the first cited week.","items":{"type":"array","minItems":2,"maxItems":2,"items":{"oneOf":[{"type":"string","format":"date"},{"type":"integer","minimum":0}]}}}}}},"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"},"tags":{"type":"object","description":"Filter by tags. Object form { \"operator\": \"IN\" | \"HAS_ALL\" | \"NOT_IN\", \"value\": [tag ids] }. IN matches items tagged with ANY of the tags; HAS_ALL matches only items tagged with ALL; NOT_IN matches only items tagged with NONE.","properties":{"operator":{"type":"string","description":"IN matches items tagged with ANY of the tags; HAS_ALL matches only items tagged with ALL of them; NOT_IN matches only items tagged with NONE of them.","enum":["IN","HAS_ALL","NOT_IN"]},"value":{"type":"array","description":"Tag IDs to filter by.","items":{"type":"integer"}}},"required":["operator","value"]},"start_date":{"type":"string","description":"Start date for metrics (ISO 8601). Defaults to 1 month before the end date."},"end_date":{"type":"string","description":"End date for metrics (ISO 8601). Defaults to the latest analysis date, or today when a start date is provided or no analysis exists."},"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","claude_code","codex","muse_spark"]}},"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","KE","KR","MX","MY","NG","NL","NO","NZ","PE","PH","PL","PT","SA","SE","SG","TH","TR","TW","US","VN","ZA"]}},"personas":{"type":"array","description":"Filter metrics by persona IDs","items":{"type":"integer"}},"id":{"type":"integer","description":"Resource ID"},"filters":{"type":"array","description":"Filter citing prompts by topic_id (EQ/IN) or prompt_type (EQUALS). brand_mentioned EQUALS is a deprecated alias for prompt_type.","items":{"type":"object","properties":{"field":{"type":"string","enum":["topic_id","prompt_type","brand_mentioned"],"description":"Filter citing prompts by topic_id (EQ/IN) or prompt_type (EQUALS). brand_mentioned EQUALS is a deprecated alias for prompt_type."},"operator":{"type":"string","enum":["EQ","IN","EQUALS"],"description":"Use the operator listed for the selected show filter."},"value":{"description":"Filter value (type depends on field and operator)"}},"required":["field","operator","value"]}},"fields":{"type":"array","description":"Select specific fields to return. Association fields require a matching include; a nested include also includes its parent. Fields do not add includes automatically.\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**: citation_rate = answers citing this URL ÷ answers in scope (0-100). Answer filters (providers, countries, personas, topics, tags, prompt_type) narrow the scope. Filters on the cited source (domain, domain_category, url, page_type, brand_mentioned, brand_sentiment) only narrow which rows are returned and don't change the rate.\n- **citation_rate_trend**: Change in citation_rate vs previous period (current − comparison), each over its own period's answers in scope.\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\n- **social**: Platform-neutral social content and account enrichment\n- **first_cited**: Optional citation decay: First observed citation date within the selected period (YYYY-MM-DD).\n- **last_cited**: Optional citation decay: Last observed citation date within the selected period (YYYY-MM-DD).\n- **peak_week**: Optional citation decay: Monday of the earliest highest-citation week in the selected period.\n- **rise_days**: Optional citation decay: Days from first observed citation to peak week, with a minimum of zero.\n- **rise_weeks**: Optional citation decay: Rise days divided by seven; may be fractional.\n- **decline_absolute**: Optional citation decay: Peak weekly count minus latest full-week count; null without a full week.\n- **decline_pct**: Optional citation decay: Decline as a percentage of peak weekly count (0-100); null without a full week.\n- **decline_week**: Optional citation decay: Monday of the latest full week used for decline; null without a full week.\n- **half_life_week**: Optional citation decay: First post-peak week with sustained halving of the two-week average; null if absent.\n- **half_life_days**: Optional citation decay: Days from peak week to sustained halving; null if not reached.\n- **weekly_series**: Optional [Monday date, citation count] pairs, starting at the first cited week, with zeroes for uncited weeks. URL, prompts, social, and brand_sentiment are always returned; decay fields are opt-in.","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","social","first_cited","last_cited","peak_week","rise_days","rise_weeks","decline_absolute","decline_pct","decline_week","half_life_week","half_life_days","weekly_series"]}}},"required":["brand_kit_id","id"]}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.