Sign in

v1

latestOpenAPI 3.0.02026-07-222980136.7 KB
Brand Reports

Get citation statistics for a brand report

get/v1/reports/brand/{reportId}/citations/stats

Path parameters

reportIdstring required

Brand report identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Brand report identifier.

Query parameters

startDatestring required

Start date for the stats window (inclusive).

Example:2025-01-01

Start date for the stats window (inclusive).

endDatestring required

End date for the stats window (inclusive).

Example:2025-01-31

End date for the stats window (inclusive).

countrystring required

Country code to filter by. Lowercase ISO 3166-1 alpha-2; use uk for the United Kingdom.

Example:us

Country code to filter by. Lowercase ISO 3166-1 alpha-2; use uk for the United Kingdom.

'chatgpt' | 'google' | 'perplexity' | 'copilot' | 'google_ai_mode' | 'gemini' | 'claude'

AI engine identifier.

OR
string[]
Example:chatgpt

Optional. AI engine(s) to filter by. Repeat the param or pass a single value.

tagIdstring

Optional. Filter stats by tag id.

Optional. Filter stats by tag id.

domainLimitinteger

Optional. Cap on number of distinct domains aggregated into the response. Positive integer.

Example:10

Optional. Cap on number of distinct domains aggregated into the response. Positive integer.

Response

Citation statistics for the brand report.

Example response

{
  "domainRank": {
    "citations": [
      {
        "domain": "adidas.com",
        "rank": 1,
        "citations": 42,
        "logoUrl": "https://logo.clearbit.com/adidas.com",
        "citationShare": 0.42,
        "main": true
      }
    ]
  },
  "domainCitations": {
    "current": 42,
    "total": 100,
    "citationShare": 0.42,
    "mostCitedUrls": [
      {
        "url": "https://www.adidas.com/us/running",
        "rank": 1,
        "currentCitations": 18,
        "citationShare": 0.42
      }
    ]
  },
  "citations": [
    {
      "url": "https://www.adidas.com/us/running",
      "rank": 1,
      "currentCitations": 18,
      "logoUrl": "https://logo.clearbit.com/adidas.com",
      "citationShare": 0.42
    }
  ],
  "competitors": [
    {
      "brandDomain": "nike.com",
      "domainCitations": {
        "current": 12,
        "total": 100,
        "citationShare": 0.12
      }
    }
  ]
}