Citations

List Citations

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brand_kit_idintegerRequired

The Brand Kit ID

Body

application/json

brand_kit_idintegerRequired

The ID of the Brand Kit

start_datestringOptional

Start date for metrics (ISO 8601). Defaults to 1 month ago.

end_datestringOptional

End date for metrics (ISO 8601). Defaults to today.

personasinteger[]Optional

Filter metrics by persona IDs

sortstring · enumOptional

Sort field. Prefix with - for descending.

Available sort fields:

• citation_count/-citation_count: Sort by citation count
• citation_share/-citation_share: Sort by citation share percentage
• citation_rate/-citation_rate: Sort by citation rate percentage
• influence_score/-influence_score: Sort by influence score

Possible values:

pageintegerOptional

Page number

Default: 1

per_pageinteger · max: 100Optional

Items per page

Default: 25

Responses

200

Successful response

application/json

400

Bad request - invalid parameters, filters, or sort options

401

Unauthorized - invalid or missing authentication token

404

Not found - resource does not exist

412

Precondition failed - AEO not configured for this brand kit

post

/public_api/brand_kits/{brand_kit_id}/citations/list

HTTPcURLJavaScriptPython

POST /public_api/brand_kits/{brand_kit_id}/citations/list HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "brand_kit_id": 1,
  "start_date": "text",
  "end_date": "text",
  "providers": [
    "chat_gpt"
  ],
  "countries": [
    "AE"
  ],
  "personas": [
    1
  ],
  "filters": [
    {
      "field": "domain_category",
      "operator": "EQUALS",
      "value": null
    }
  ],
  "fields": [
    "url"
  ],
  "sort": "citation_count",
  "page": 1,
  "per_page": 25
}

{
  "data": [
    {
      "url": "text",
      "domain": 1,
      "domain_name": "text",
      "domain_category": "text",
      "logo_url": "text",
      "citation_count": 1,
      "citation_count_trend": 1,
      "citation_share": 1,
      "citation_share_trend": 1,
      "citation_rate": 1,
      "citation_rate_trend": 1,
      "influence_score": 1,
      "influence_score_breakdown": {},
      "page_type": "homepage",
      "brand_mentioned": true,
      "brand_sentiment": "negative",
      "mentioned_competitor_domains": [
        {}
      ],
      "domain_authority": 1
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 1,
    "total_count": 1,
    "total_pages": 1,
    "data_availability": {
      "earliest_data_date": "text",
      "latest_data_date": "text",
      "requested_period_has_data": true
    }
  }
}

Get Citation

post

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

brand_kit_idintegerRequired

The Brand Kit ID

Body

application/json

brand_kit_idintegerRequired

The ID of the Brand Kit

start_datestringOptional

Start date for metrics (ISO 8601). Defaults to 1 month ago.

end_datestringOptional

End date for metrics (ISO 8601). Defaults to today.

personasinteger[]Optional

Filter metrics by persona IDs

idintegerRequired

Resource ID

Responses

200

Successful response

application/json

400

Bad request - invalid parameters, filters, or sort options

401

Unauthorized - invalid or missing authentication token

404

Not found - resource does not exist

412

Precondition failed - AEO not configured for this brand kit

post

/public_api/brand_kits/{brand_kit_id}/citations/show

HTTPcURLJavaScriptPython

POST /public_api/brand_kits/{brand_kit_id}/citations/show HTTP/1.1
Host: api.airops.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "brand_kit_id": 1,
  "start_date": "text",
  "end_date": "text",
  "providers": [
    "chat_gpt"
  ],
  "countries": [
    "AE"
  ],
  "personas": [
    1
  ],
  "id": 1,
  "filters": [
    {
      "field": "domain_category",
      "operator": "EQUALS",
      "value": null
    }
  ],
  "fields": [
    "url"
  ]
}

{
  "data": {
    "url": "text",
    "domain": 1,
    "domain_name": "text",
    "domain_category": "text",
    "logo_url": "text",
    "citation_count": 1,
    "citation_count_trend": 1,
    "citation_share": 1,
    "citation_share_trend": 1,
    "citation_rate": 1,
    "citation_rate_trend": 1,
    "influence_score": 1,
    "influence_score_breakdown": {},
    "page_type": "homepage",
    "brand_mentioned": true,
    "brand_sentiment": "negative",
    "mentioned_competitor_domains": [
      {}
    ],
    "domain_authority": 1
  }
}