Skip to main content
GET
Visibility Change Decomposition

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

start_date
string<date>
required

Start of the current period. The previous period of equal length, ending the day before start_date, is compared automatically.

end_date
string<date>
required

End of the current period. Must be on or after start_date.

brand
string<uuid>

Brand UUID to analyse. Must belong to the project. Defaults to the project's primary brand. Discover brand UUIDs with GET /api/v1/projects/{project}/brands.

services
string[]

AI platform provider filters such as chatgpt or perplexity. Pin a single provider (using a segment id from a previous response) to drill into that platform. Discover providers with GET /api/v1/platforms.

countries
string[]

Country code filters such as US or GB. Pin a single code (using a segment id from a previous response) to drill into that country. Discover codes with GET /api/v1/countries.

topics
string[]

Topic UUID or name filters. Use no_topic for prompts without a topic. Pin a single topic (using a segment id from a previous response) to drill into it. Discover topics with GET /api/v1/projects/{project}/topics.

tags
string[]

Tag UUID or name filters. Tags restrict the analysed prompt set but are not a drill dimension. Discover tags with GET /api/v1/projects/{project}/tags.

prompt
string<uuid>

Prompt UUID filter.

include_prompts
boolean

When true, appends a prompt dimension listing the individual prompts with the largest absolute contributions (capped at 10, ranked largest first). Use it at the end of a drill to see which questions drove the change. Prompt segment ids are prompt UUIDs and can be passed back as the prompt filter or to the mentions endpoint. Unlike the partitioning dimensions, this capped list is a ranked shortlist - its contributions do not necessarily sum to the overall change.

Response

Period-over-period visibility change decomposed per dimension.

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

Start of the automatically derived previous period.

comparison_end_date
string<date>
required

End of the automatically derived previous period.

before_visibility
number
required

Overall visibility in the comparison period (0-1 scale).

after_visibility
number
required

Overall visibility in the current period (0-1 scale).

before_responses
integer
required
after_responses
integer
required
dimensions
object[]
required