GET
Rank Products

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.

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.

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
metric
enum<string>
default:visibility
Available options:
visibility,
recommendation
label
enum<string>
default:brand
Available options:
brand,
competitor
category
string | null
order
enum<string>
default:desc

desc: the highest first. asc: the lowest first.

Available options:
asc,
desc
page
integer
default:1
Required range: x >= 1
page_size
integer
default:50
Required range: 1 <= x <= 50

Response

Successful Response

data
RankedProduct · object[]
required
info
ProductsInfo · object
required