Skip to main content
GET
Report Entity Schema

Authorizations

Authorization
string
header
required

Team API key created in Team Settings. Use it with URLs for the same team.

Path Parameters

entity
enum<string>
required

The report entity. A report entity. visibility: brand visibility, mentions, position, sentiment and rank; with the answer dimension, one row per AI answer (a list, no compare window). sources: cited domains, hostnames, URLs and pages. narratives: reputation narratives, themes and sentiment (needs the Reputation capability).

Available options:
visibility,
sources,
narratives

Response

200 - application/json

The entity schema.

What one entity accepts: its dimensions, measures, filter fields with roles and operators, and related blocks.

entity
enum<string>
required

A report entity. visibility: brand visibility, mentions, position, sentiment and rank; with the answer dimension, one row per AI answer (a list, no compare window). sources: cited domains, hostnames, URLs and pages. narratives: reputation narratives, themes and sentiment (needs the Reputation capability).

Available options:
visibility,
sources,
narratives
title
string
required
requires_dimensions
boolean
required
entity_columns
object[]
required

Columns every row carries before the dimension columns. Empty on every current entity.

dimensions
object[]
required
measures
object[]
required
filter_fields
object[]
required
order_fields
string[]
required

Every field order_by accepts: dimensions, measures with their compare columns, and extra sort fields such as answered_at on visibility.

Related block id to a one-line description.