Getting Started

Sections

Theme switcher

Prompt Tracking

Header Parameters

api-keystring

Query Parameters

granularitystring

Time granularity for the returned values

Enum values:
daily
start_datestring Required

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format

end_datestring Required

End date in 'YYYY-MM' or 'YYYY-MM-DD' format

metricsarray

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

Enum values:
promptresponsebrands_mentionedcitationssentimentllm
campaign_idstring Required

Unique campaign identifier (UUID format)

topicstring

Filter results by specific topic

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

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

Nullable:
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
Success

Response Attributes

metaobject

Show child attributes

dataarray
Nullable:
True

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in Claude

Code with AI