Getting Started

Sections

Theme switcher

Get AI tracker prompts data

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

Metrics to include in the response: prompt, response, brands_mentioned, citations, sentiment

Style
form
Enum values:
promptresponsebrands_mentionedcitationssentiment
brandsarray

Filter by brands mentioned in prompts (comma-separated list)

Style
form
sentimentsarray

Filter by sentiment analysis results: positive, negative, neutral, not Mentioned (comma-separated list)

Style
form
Enum values:
not_mentionedpositiveneutralnegative
search_termstring

Search term to filter prompts by text content

campaign_idstring Required

Unique campaign identifier (UUID format)

topicsarray

Filter results by topics (comma-separated list)

Style
form
llmsarray

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

Style
form
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 1000

ascboolean | null

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

sortstring

Selects a field to order results by. Default sorting is by date. Supported values: date, prompt, sentiment, response

offsetinteger

Defines the number of results to skip

Response

200
Object

OK

Response Attributes

metaobject

Show child attributes

dataarray | null

Show child attributes

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot