GET
Perceptions

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"

models
enum<string>[] | null

The answer engines. With no list, each engine.

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
page
integer
default:1

The page, from 1.

Required range: x >= 1
page_size
integer
default:50

The rows of a page.

Required range: 1 <= x <= 100
sentiment
enum<string> | null
Available options:
positive,
neutral,
negative
fact_check
enum<string> | null

confirmed: the facts of the brand support it. contradicted: they go against it. unconfirmed: not checked yet.

Available options:
confirmed,
contradicted,
unconfirmed
in_knowledge_base
boolean | null

Whether the knowledge base of the brand holds it.

search
string | null

A part of the text.

Maximum string length: 200

Response

Successful Response

data
Perception · object[]
required
info
PerceptionsInfo · object
required