Skip to main content
GET
Get Aggregated Insights Metrics

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id
string
required
workspace_id
string
required

Query Parameters

date_start
string<date>
required

Start of the date range (YYYY-MM-DD)

date_end
string<date>
required

End of the date range (YYYY-MM-DD)

period
enum<string>
default:week

Comparison period granularity

Available options:
week,
month
dimensions
enum<string>[] | null

Dimensions to group by

Available options:
brand,
country,
category,
source,
keyword_type
sources
enum<string>[] | null

Filter by sources

Available options:
Bing,
BingAIO,
ChatGPT,
Perplexity,
Google,
GoogleAIO,
GoogleAIMode,
Claude,
Gemini,
AmazonRufus,
Grok,
Copilot,
Mistral
countries
enum<string>[] | null

Filter by countries

Available options:
AR,
AT,
AU,
AE,
BH,
BE,
BO,
BR,
CA,
CN,
CO,
CR,
DK,
DO,
EC,
ES,
FI,
FR,
DE,
GB,
GT,
HK,
HU,
ID,
IE,
IL,
IN,
IT,
JP,
KR,
KW,
LU,
MA,
MX,
MY,
NG,
NL,
NO,
NZ,
PA,
PH,
PK,
PL,
PT,
QA,
RO,
SA,
SE,
SG,
CH,
TH,
TR,
TW,
US,
VN,
ZA
brands
string[] | null

Filter by brands

categories
string[] | null

Filter by categories

keyword_types
string[] | null

Filter by keyword types (Brand or Generic)

Response

Successful Response

visibility_score
Metric · object
required

Visibility score for this group.

brand_mention_rate
Metric · object
required

Brand mention rate as a percentage.

domain_presence_rate
Metric · object
required

Domain presence rate as a percentage.

sentiment_score
Metric · object
required

Net sentiment score (positive rate minus negative rate).

average_position
Metric · object
required

Average ranking position. Lower is better.

sentiment_positive
Metric · object
required

Share of positive citations as a percentage.

sentiment_negative
Metric · object
required

Share of negative citations as a percentage.

sentiment_neutral
Metric · object
required

Share of neutral citations as a percentage.

group
Group · object | null

Dimension group this row belongs to (e.g. {'brand': 'Acme'}). Null when no dimensions requested.