OTotterly
Brand Reports

List citations for a brand report

Changed on
get/v1/reports/brand/{reportId}/citations

Request

  • Base URL
    https://data.otterly.ai
  • Auth
    HTTP bearer

Path parameters

reportIdstring required

Brand report identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Query parameters

startDatestring required

Start date for the citations window (inclusive).

Example:2025-01-01
endDatestring required

End date for the citations window (inclusive).

Example:2025-01-31
countrystring required

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

Example:us
frequency'daily' | 'weekly'

Optional. weekly buckets the periods by ISO week (a weekly run lands on its week's Monday; the current, unfinished week is left out). Defaults to weekly for a workspace monitored weekly, otherwise daily.

Example:weekly
'chatgpt' | 'google' | 'perplexity' | 'copilot' | 'google_ai_mode' | 'gemini' | 'claude'

AI engine identifier.

OR
string[]
Example:chatgpt
tagIdstring

Optional. Filter citations by tag id.

string
OR
string[]
searchstring

Optional. Free-text search.

offsetinteger

Optional. Zero-based offset for pagination; must be a multiple of limit. Defaults to 0.

limitinteger

Optional. Maximum number of items to return, up to 1000. Defaults to 25. For more rows, page with offset.

sortBystring

Optional. Field to sort by.

sortOrder'asc' | 'desc'

Optional. Sort direction.

brandMentionedboolean

Optional. Filter citations where the brand is mentioned.

string
OR
string[]
'Social Media' | 'Community/Forum' | 'Brand' | 'Encyclopedia' | 'News/Media' | 'Blogs/Personal Sites' | 'Government/NGO' | 'Education' | 'Video' | 'Competitor' | 'Others' | 'Unclassified'

Domain classification.

OR
string[]
Example:News/Media

Response

A page of citations for the brand report.

Example response

{
  "items": [
    {
      "url": "https://www.adidas.com/us/running",
      "domain": "adidas.com",
      "title": "Adidas Running Shoes & Apparel",
      "citations": 7469,
      "prompts": [],
      "isMyBrandDomain": true,
      "competitors": [
        {
          "brand": "Nike"
        },
        {
          "brand": "Asics"
        },
        {
          "brand": "New Balance"
        }
      ],
      "brandMentioned": 1,
      "domainCategory": "Brand"
    }
  ],
  "paging": {
    "limit": 25,
    "offset": 0,
    "hasMore": true
  }
}

Changes

  • 333e3100f0b4Revision changes
    • info

      added the new optional query request parameter frequency

  • b5dc4bea6d45Revision changes
    • info

      the response property // became required for the status

    • info

      added the required property / to the response with the status