API explorer
Getting Started

Sections

Theme switcher

Prompts

Header Parameters

api-keystring

Query Parameters

granularitystring

Time granularity for the returned values

Enum values:
daily
start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

metricsarray

Comma-separated list of metrics to include. Omit to return all metrics.

Enum values:
visibilitypop_changeavg_sentiment_scorelatest_citation_statuscitation_gaplatest_mention_statusmention_sharementions_countcitation_countcompetitors_avg_visibility
... 1 other enums
campaign_idstring Required

Unique campaign identifier (UUID format)

llmsarray

Filter by LLM providers: chatgpt, google_ai_mode, perplexity, gemini (comma-separated list)

Enum values:
chatgptgoogle_ai_modeperplexitygemini
formatstring

Format in which the reply should be returned

Enum values:
jsonxml
limitinteger

Sets how many results to return. Default is 100. Must be between 1 and 1200

ascboolean | null

Orders the results by ascending (true) or descending (false). Default is descending (false).

sortstring

Selects a field to order results by. Supported values: visibility. Default sorting is by visibility descending.

offsetinteger

Defines the number of results to skip

Response

200
Object

OK

Response Attributes

metaobject
dataarray | null
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?