Get scores

Authorizations

Authorization

string

header

required

API key authentication. Include your API key in the Authorization header: Authorization: Bearer YOUR_API_KEY

Query Parameters

brand

string

required

The brand ID (32-character hexadecimal string)

Required string length: 32

breakdown

enum<string>[]

Array of breakdown types. Valid values:

[] or omitted - No breakdown, returns only time series data
["model"] - Break down by AI model
["prompt"] - Break down by prompt
["model", "prompt"] - Break down by both

Maximum array length: 2

Available options:

model,

prompt

start_date

string<date>

Start date in YYYY-MM-DD format. If not provided, defaults to 28 days before end_date. The total date range cannot exceed 90 days.

end_date

string<date>

End date in YYYY-MM-DD format. If not provided, defaults to the most recent report date for the brand. The total date range cannot exceed 90 days.

Response

Successful response

brand_id

string

required

The brand ID that was queried

Example:

"0000000000000x000000000000000000"

brand_name

string

required

The human-readable brand name

Example:

"Acme Corporation"

start_date

string<date>

required

The start date used for the query

Example:

"2025-01-01"

end_date

string<date>

required

The end date used for the query

Example:

"2025-01-31"

breakdown

enum<string>[]

required

The breakdown types that were requested

Available options:

model,

prompt

Example:

["model"]

data

object[]

required

Array of daily report data

Show child attributes

data.date

string<date>

required

The report date

Example:

"2025-01-01"

data.visibility

number<float>

required

Brand visibility score (0.00 to 100.00)

Required range: 0 <= x <= 100

Example:

85.5

data.presence

number<float>

required

Brand presence score (0.00 to 100.00)

Required range: 0 <= x <= 100

Example:

92.3

data.models

object[]

Model breakdown data (present if "model" in breakdown)

Show child attributes

data.models.model

string

required

The AI model name

Example:

"OpenAI"

data.models.visibility

number<float>

required

Model-specific visibility score

Required range: 0 <= x <= 100

Example:

88.2

data.models.presence

number<float>

required

Model-specific presence score

Required range: 0 <= x <= 100

Example:

94.1

data.prompts

object[]

Prompt breakdown data (present if "prompt" in breakdown)

Show child attributes

data.prompts.id

string

required

Unique prompt identifier

Example:

"prompt_001"

data.prompts.visibility

number<float>

required

Prompt-specific visibility score

Required range: 0 <= x <= 100

Example:

89.3

data.prompts.presence

number<float>

required

Prompt-specific presence score

Required range: 0 <= x <= 100

Example:

95.2

data.prompts.prompt

string

required

The actual prompt text

Example:

"What are the best financial services companies?"

data.model_prompt_breakdown

object[]

Combined model/prompt data (present if both in breakdown)

Show child attributes

data.model_prompt_breakdown.model

string

required

The AI model name

Example:

"OpenAI"

data.model_prompt_breakdown.prompt

string

required

The prompt text

Example:

"What are the best financial services companies?"

data.model_prompt_breakdown.rank

number | null

Brand's average position in the response (null if not mentioned). For multiple results with the same model/prompt combination, this represents the average rank.

Required range: x >= 1

Example:

3

errors

string[] | null

Array of non-critical error messages (null if no errors)

Getting Started

API Endpoints

Authorizations

Query Parameters

Response