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, and the bucket of the date dimension

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

Dimensions to group by. date is the first day of the week (Monday) or month of period the collects fall in, as YYYY-MM-DD.

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

Filter by sources

Available options:
Bing,
BingAIO,
ChatGPT,
Perplexity,
Google,
GoogleAIO,
GoogleAIMode,
Claude,
Gemini,
AmazonRufus,
Grok,
Copilot,
Mistral,
MuseSpark
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,
PE,
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)

project_ids
string[] | null

Restrict the aggregation to these analyses (project ids) of the workspace. An analysis of another workspace matches nothing.

Response

Successful Response

group_metadata
InsightsGroupMetadata · object
required

What the group's numbers come from: how many workspaces and analyses. Not a metric.

visibility_score
InsightsMetric · object
required

(deprecated) Legacy visibility score: domain and brand scores stacked. Superseded by ai_visibility.ai_visibility_score and performance.performance_score.

brand_mention_rate
InsightsMetric · object
required

(deprecated) Legacy name of ai_visibility.brand_presence_rate, truncated to an integer.

domain_presence_rate
InsightsMetric · object
required

(deprecated) Legacy name of influence.citation_presence_rate, truncated to an integer. The Domain Presence Rate KPI is performance.domain_presence_rate.

sentiment_score
InsightsMetric · object
required

Net sentiment score (positive rate minus negative rate).

average_position
InsightsMetric · object
required

(deprecated) Legacy name of performance.average_top_position.

sentiment_positive
InsightsMetric · object
required

Share of positive citations as a percentage.

sentiment_negative
InsightsMetric · object
required

Share of negative citations as a percentage.

sentiment_neutral
InsightsMetric · object
required

Share of neutral citations as a percentage.

ai_visibility
InsightsAiVisibility · object
required

AI Visibility KPIs of the brand, one decimal.

influence
InsightsInfluence · object
required

Influence KPIs of the domain, one decimal.

performance
InsightsPerformance · object
required

Performance KPIs of the domain, one decimal.

group
Group · object | null

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