Skip to main content
GET
Get citations

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header: Authorization: Bearer YOUR_API_KEY

Query Parameters

brand
string
required

The brand ID (32-character hexadecimal string)

Required string length: 32
Pattern: ^[0-9a-fx]{32}$
mode
enum<string>
default:citations

Citation mode to use:

  • citations - AI Search citations with aggregates
  • search-queries - Search queries with associated citations
  • knowledge - Knowledge base citations
Available options:
citations,
search-queries,
knowledge
start_date
string<date>

Filter by last seen date (YYYY-MM-DD). Only applies to citations and search-queries modes.

Pattern: ^\d{4}-\d{2}-\d{2}$
end_date
string<date>

Filter by last seen date (YYYY-MM-DD). Only applies to citations and search-queries modes.

Pattern: ^\d{4}-\d{2}-\d{2}$
domain
string

Filter citations by domain (substring match)

query
string

Filter search queries by query text (substring match). Only applies to search-queries mode.

limit
integer
default:100

Number of items per page (1-500)

Required range: 1 <= x <= 500
cursor
string

Pagination cursor from previous response

Response

Successful response

brand_id
string
required

The brand ID

Example:

"1749113348709x432280934699237400"

mode
enum<string>
required

Response mode

Available options:
citations
Example:

"citations"

updated_at
string<date-time>
required

When the snapshot was last updated

Example:

"2025-11-03T01:42:25.502006+00:00"

citations
object[]
required

Array of citation items

pagination
object
required
summary
object | null

Top aggregates (only included when no filters applied)