GET
Get Product

Authorizations

X-API-Key
string
header
required

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

Path Parameters

product_id
integer
required

A product of the brand.

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

Response

Successful Response

id
integer
required
label
string
required
title
string
required
category
string | null
competitor_name
string | null
image_url
string | null
manufacturer
string | null
offers
VariantOffers · object[]

The retailers of the product and of each variant.

product_line
string | null
product_name
string | null
searches
QueryCount · object[]

The web searches of the engines that led to it, top 5.

shopping_queries
QueryCount · object[]

The shopping queries of the engines that show it, top 5.

snapshot
ProductSnapshot · object | null

The product in the newest answer that shows it.

titles
TitleCount · object[]

The names that the answers give it, top 5.

topics
TopicCount · object[]

The topics that show it, top 5.

variant_axes
string[]
Example: