Sign in

v1

latestOpenAPI 3.1.02026-07-247601.0 MB
Analytics

Query Analytics Report

This endpoint doesn't consume Apollo credits. Learn more about API pricing and credits.

Use the Query Analytics Report endpoint to programmatically query <a href="https://knowledge.apollo.io/hc/en-us/articles/33574373762317-Analytics-Overview" target="_blank">Apollo analytics</a> and retrieve aggregated sales activity data for your team.<br><br>This endpoint accepts a flexible payload specifying which metrics to measure, how to group and filter results, and which date range to apply — returning the same data that powers Apollo's built-in Analytics dashboards. <br><br>Three query modes are supported: flat totals (no <code>group_by</code>), grouped by one dimension such as user or sequence, and pivot cross-tab (one <code>group_by</code> dimension as rows + one <code>pivot_group_by</code> dimension as columns). Each array supports a maximum of one entry.<br><br> <strong>Authentication:</strong> Requires an Apollo API key with access to the <code>api/v1/reports/sync_report</code> API. When creating or editing an API key in Apollo Settings, open the <strong>APIs</strong> tab and select <code>api/v1/reports/sync_report</code> from the list. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> for detailed instructions.<br><br><strong>Tip:</strong> The easiest way to discover valid metric and group_by combinations is to build a report interactively at <a href="https://app.apollo.io/#/analytics/reports/new" target="_blank">Apollo Analytics → Start from scratch</a>, then replicate that configuration in your API request.

post/reports/sync_report

Request body

group_by_totals_selectedboolean required

When <code>true</code>, the response includes an aggregated totals row in addition to the per-dimension-value rows.

pivot_group_by_totals_selectedboolean required

When <code>true</code>, the pivot response includes an aggregated totals column in addition to the per-pivot-value columns.

skip_group_by_valuesstring[]

Exclude specific dimension values from the result rows. Values must match the raw <code>key</code> field returned in bucket responses for the active <code>group_by</code> dimension (e.g. a contact stage ID string, a user ID string, or a date string for datetime dimensions). Maximum 500 entries.

min_ratio_denominatorinteger

Minimum denominator threshold for ratio metrics. Rows where the denominator falls below this value are excluded from ratio calculations.

Response

200

incompatible_filtersobject

A map of filter keys that were incompatible with one or more requested metrics and were silently ignored. Keys are filter names; values are arrays of affected metric names. Inspect this field when results appear incomplete.

goalsobject[]

Goal attainment data. This field is unrelated to data querying — you can ignore it.