Skip to main content
GET
Metrics Over Time

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id
string
required
workspace_id
string
required
project_id
string
required

Query Parameters

score
enum<string>
required

Score to return one point per collection date for.

Available options:
presence_rate,
influence_score,
average_position
metric_type
enum<string> | null

Which records the score is computed over. presence_rate: domain, citation or brand (default domain). average_position: domain or citation (default domain). influence_score: not accepted.

Available options:
domain,
citation,
brand
brand
string | null

Brand override for presence_rate with metric_type=brand; defaults to the project brand terms. Rejected with a 422 for any other combination.

date_start
string<date>
required

Start of the date range (YYYY-MM-DD).

date_end
string<date>
required

End of the date range (YYYY-MM-DD, inclusive).

sources
enum<string>[] | null
Available options:
Bing,
BingAIO,
ChatGPT,
Perplexity,
Google,
GoogleAIO,
GoogleAIMode,
Claude,
Gemini,
AmazonRufus,
Grok,
Copilot,
Mistral
thematics
string<uuid>[] | null

Filter by a list of thematic IDs

keyword_type
enum<string>[] | null

Filter by a list of keyword types

Available options:
Generic,
Brand
funnel_stages
enum<string>[] | null

Filter by a list of Funnel Stages

Available options:
ToFu,
MoFu,
BoFu
persona_ids
string[] | null

Filter by a list of persona IDs

topic_ids
string[] | null

Filter by a list of topic IDs

get_neutrals
boolean | null

Filter by to get results related to neutral prompts, without weakness or strength

strength_ids
string[] | null

Filter by a list of strength IDs

weakness_ids
string[] | null

Filter by a list of weakness IDs

Response

Successful Response

score
enum<string>
required

Discriminator: the score this item belongs to.

Available options:
presence_rate
collection_date
string
required

Collection date in YYYY-MM-DD format.

metric_type
enum<string>
required

Presence metric selected by the request.

Available options:
domain,
citation,
brand
value
Metric · object
required

Presence rate (%) on this date, across every selected engine and thematic. Always numeric: a date whose collects held nothing in scope reports 0 with total 0, which is what distinguishes it from a genuine 0% over a non-zero total.

total
integer
required

Distinct eligible keyword/collect/engine observations on this date.

occurrences
integer
required

Distinct observations containing the matching domain or brand.