Skip to main content
GET
Get Brand Perception Competitive Breakdown

Authorizations

X-API-Key
string
header
required

Query Parameters

project_id
string

Required if using a company api key

Example:

"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"

model_channel_ids
enum<string>[]

Only include answers from these AI engine channels (repeat the parameter for multiple values). Omit to aggregate across all tracked channels.

Available options:
openai-0,
openai-1,
qwen-0,
openai-2,
perplexity-0,
perplexity-1,
google-0,
google-1,
google-2,
google-3,
google-4,
anthropic-0,
anthropic-1,
deepseek-0,
meta-0,
meta-1,
xai-0,
xai-1,
microsoft-0,
amazon-0,
mistral-0,
mistral-1,
naver-0
industry
string

Only read the runs dispatched for this industry, as returned by the brand-perception industries endpoint. Omit to read the industry marked is_default there — the one with the most recent completed run.

Example:

"Luxury Sports Cars"

limit
integer
default:1000
Required range: 1 <= x <= 10000
offset
integer
default:0
Required range: 0 <= x <= 9007199254740991

Response

200 - application/json

Success

Success

data
object[]
required

Attributes sorted by the own brand's score, strongest first.

total_count
number
required

Total number of attributes, ignoring pagination

Example:

8

industry
string | null
required

The industry the data was read from; null when the project has no brand-perception runs yet.

Example:

"Luxury Sports Cars"

target_market
string | null
required

The target market the read narrowed to within that industry — its most recently completed one. Runs dispatched for the industry's other markets are not included.

Example:

"Germany"

industries
object[]

Every industry the project has runs for, latest-started first — present only when there is more than one. Pass a name as industry to read that one instead.