GET
Visibility Report

Authorizations

X-API-Key
string
header
required

An API key of your account, from Settings > API Keys. It starts with gnz-.

Path Parameters

brand_id
integer
required

Query Parameters

start_date
string | null

YYYY-MM-DD (a day in UTC) or an ISO 8601 datetime. Both ends of the range are inclusive: an end date covers its whole day.

Example:

"2026-09-01"

end_date
string | null

YYYY-MM-DD (a day in UTC) or an ISO 8601 datetime. Both ends of the range are inclusive: an end date covers its whole day.

Example:

"2026-09-30"

granularity
enum<string>
default:day

The length of a period: a day, a week (from Monday), or a month. A week is the average of its days. A month is the average of the days of its last week.

Available options:
day,
week,
month
models
enum<string>[] | null

The answer engines. With no list, the engines of the brand.

Minimum array length: 1

The answer engines that the public API names.

The platform also runs models of the API of OpenAI for its own work, such as gpt-4o. A customer does not choose them, thus the public API does not name them. Each value is a value of dtos.simulation.LlmModel.

Available options:
chatgpt.com,
google-ai-overview,
perplexity,
claude,
google-ai-mode,
google-gemini,
copilot,
deepseek,
grok,
gpt-5.4
topic_ids
integer[] | null

The topics of the brand. With no list, each topic.

Minimum array length: 1
group_by
string | null

model: one series for each answer engine, in place of one series for each engine together.

Allowed value: "model"
competitors
boolean
default:true

Also give the series of each competitor.

Response

Successful Response

data
VisibilityRow · object[]
required
info
ReportInfo[VisibilitySummary] · object
required