Skip to main content
GET
Matrix Analysis

Authorizations

Authorization
string
header
required

Team API key created in Team Settings. Use it with URLs for the same team.

Path Parameters

project
string<uuid>
required

Project UUID.

Query Parameters

row_dimension
enum<string>
required
Available options:
brand,
tag,
country,
service,
topic
column_dimension
enum<string>
required

Must differ from row_dimension.

Available options:
brand,
tag,
country,
service,
topic
metric
enum<string>
required
Available options:
industry_rank,
visibility,
mentions,
avg_position
brands
string<uuid>[]

Brand UUIDs. Pass repeated brands[]=... query params.

Maximum array length: 10
tags
string[]

Tag UUID or name filters. Discover tags with GET /api/v1/projects/{project}/tags.

services
string[]

AI platform provider filters such as chatgpt or perplexity. Discover providers with GET /api/v1/platforms.

countries
string[]

Country code filters such as US or GB. Discover codes with GET /api/v1/countries.

prompt
string<uuid>

Prompt UUID filter.

topics
string[]

Topic UUID or name filters. Use no_topic for prompts without a topic. Discover topics with GET /api/v1/projects/{project}/topics.

start_date
string<date>
required
end_date
string<date>
required

Must be on or after start_date.

competitors_only
boolean

When true, brand dimensions only include the primary brand and marked competitors.

Response

Matrix analysis result.

row_dimension_type
enum<string>
required
Available options:
brand,
tag,
country,
service,
topic
column_dimension_type
enum<string>
required
Available options:
brand,
tag,
country,
service,
topic
metric_type
enum<string>
required
Available options:
industry_rank,
visibility,
mentions,
avg_position
rows
object[]
required
columns
object[]
required