Skip to main content
GET
Brand mention rows for BI tools

Authorizations

Authorization
string
header
required

An API key. Scopes are granted per key: read:projects, read:visibility, read:content, read:demand, read:agents, read:tables, read:facts, and the write scopes run:agents and write:facts.

Scopes

read:visibility

Query Parameters

from
string<date>

First day, YYYY-MM-DD; defaults to 29 days before to

to
string<date>

Last day, YYYY-MM-DD; defaults to today (UTC). At most 366 days from from

project_id
string

Comma-separated brand ids, up to 100; every brand the key may read when absent

Maximum string length: 3700
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(,[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})*$
engine
string

Comma-separated engines (ai_overview, ai_mode, chatgpt, perplexity, claude, copilot, gemini); all when absent

Maximum string length: 200
Pattern: ^(ai_overview|ai_mode|chatgpt|perplexity|claude|copilot|gemini)(,(ai_overview|ai_mode|chatgpt|perplexity|claude|copilot|gemini))*$
runs
enum<string>
default:all

complete leaves out run dates that answered under half the prompt set, as the dashboard does

Available options:
all,
complete
limit
integer
default:1000

Answers read per page, 1-5000. A page holds whole days, so it may run past the limit by the rest of its last day

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

Opaque cursor from the previous page's next_cursor

Maximum string length: 1024

Response

OK

One page of mention rows

data
object[]
required
next_cursor
string | null
required

Pass as cursor for the next page; null on the last page