Skip to main content
POST
Drill into a brand stance: the AI responses where it was discouraged/recommended/…

Headers

x-project-id
string
required

Project ID to specify the project context

Body

application/json
entityId
string
required

Entity (brand) id — canonical or a merged source.

Example:

"550e8400-e29b-41d4-a716-446655440000"

mentionType
enum<string>
required

Stance (mention_type) to filter on.

Available options:
mentioned,
discussed,
recommended,
discouraged
startDate
string

Start date (inclusive)

Example:

"2025-01-01"

endDate
string

End date (exclusive)

Example:

"2025-02-01"

countries
string[]

Filter by country codes

Example:
languages
string[]

Filter by language codes

Example:
models
string[]

Filter by AI models

Example:
queryIds
string[]

Filter by query IDs

Example:
hasSources
enum<string>

Filter by source presence: "sources" (only with sources), "no_sources" (only without), "all" (no filter). Legacy true/false values are still accepted.

Available options:
all,
sources,
no_sources
hasShopping
enum<string>

Filter by shopping presence: "shopping" (only with shopping), "no_shopping" (only without), "all" (no filter). Legacy true/false values are still accepted.

Available options:
all,
shopping,
no_shopping
queryTagIds
string[]

Filter by query tag IDs (numeric — bigint column)

Example:
execTagIds
string[]

Filter by execution tag IDs

Example:
queryTagGroupIds
string[]

Filter by query tag group IDs — matches rows carrying any tag filed under a selected group. Combines with queryTagIds per queryTagMode.

Example:
execTagGroupIds
string[]

Filter by execution tag group IDs — matches rows carrying any tag filed under a selected group. Combines with execTagIds per execTagMode.

Example:
queryTypes
enum<string>[]

Filter by query type. Include "untyped" to also match queries without a type. Results from since-deleted queries are excluded when this filter is set.

Available options:
comparative,
informative,
perception,
untyped
queryTagMode
enum<string>
default:or

Query tag matching mode: "or" matches ANY tag (default), "and" matches ALL tags.

Available options:
and,
or
execTagMode
enum<string>
default:or

Execution tag matching mode: "or" matches ANY tag (default), "and" matches ALL tags.

Available options:
and,
or
timezone
string
default:UTC

IANA timezone for date bucketing and filtering (e.g. "Europe/Brussels"). Defaults to UTC.

Example:

"Europe/Brussels"

groupBy
enum<string>

Row grouping level for entity results. "none" = one row per entity, "division" = one row per division (entities not in a division get their own row), "group" = one row per top-level group (divisions roll up into their group). Defaults to "none".

Available options:
none,
division,
group
groupByEntityGroup
boolean
deprecated

Deprecated — use groupBy instead. true is equivalent to groupBy="group".

Example:

false

showAllEntities
boolean

Include entities that have only ever been seen in a single AI response. These are mostly one-off extraction noise and are hidden by default.

Example:

false

page
number

Page number (1-based). Default: 1.

Example:

1

pageSize
number

Results per page. Default: 10, max: 50.

Example:

10

Response

responses
object[]
required
page
object
required