Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Query Parameters

input_start_date
string<date>
required

Start date in YYYY-MM-DD format

input_end_date
string<date>
required

End date in YYYY-MM-DD format

input_model_name
enum<string>
required

Name of the model to use The specific model to use for analysis

Available options:
chatgpt,
perplexity,
google-overview,
gemini,
deepseek,
claude

Response

Ranking response

brand
string
required

Brand name

brand_id
integer
required

ID of the brand

color
string
required

Hex color for the brand

visible_query_count
integer
required

Total number of queries where brand was visible

total_query_count
integer
required

Total number of queries for the given filters

percentage_difference
number<float>
required

Percentage change within the date range.

overall_visibility
number<float>
required

Percent of visibility (visible / total queries)

position
object
required

Breakdown of mentions by position (1-10). They will sum up to visible_query_count.

sentiment
object
required

Breakdown of sentiment counts. They will sum up to visible_query_count.