Apollo Sequences · Outreach

apollo-rest-api / Query analytics report

Endpoint essentials API key access: api/v1/reports/syncreport or Master API key **OAuth scopes:** reportsync Credit usage: 0 credits — Learn more about API pricing and credits. Use the query analytics report endpoint to programmatically query Apollo analytics and retrieve aggregated sales activity data for your team. 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. Three query modes are supported: flat totals (no groupby), grouped by one dimension such as user or sequence, and pivot cross-tab (one groupby dimension as rows + one pivotgroupby dimension as columns). Each array supports a maximum of one entry. Authentication: Requires an Apollo API key with access to the api/v1/reports/syncreport API. When creating or editing an API key in Apollo Settings, open the APIs tab and select api/v1/reports/syncreport from the list. Check out Create an API Key for detailed instructions. Tip: The easiest way to discover valid metric and group_by combinations is to build a report interactively at Apollo Analytics → Start from scratch, then replicate that configuration in your API request.

Private Gateway connection

Data below comes from the configured private Gateway. Provider activation remains governed by its evidence and policy gates.

unverifiedRequest shape unavailableUnverified

Published API evidence

Public metadata only. Response bodies, credentials, and internal review notes are never displayed.

No verification date is claimed. No response capture is claimed.

Request parameters

date_ranges body · required
The time window for the query. Provide one object with a <code>modality</code> preset. For a custom date range, set <code>modality</code> to <code>custom_range</code> and add a <code>smart_datetime_range</code> key in <code>filters</code> with <code>{"min": "YYYY-MM-DD", "max": "YYYY-MM-DD"}</code>.
filters body · required
Key/value filter map to narrow the result set. Pass an empty object <code>{}</code> for no filters. Common filter keys are documented in the <code>properties</code> below; additional dimension-based filters may also be passed using the same key names as <code>group_by[].name</code> values. Refer to the <a href="https://docs.apollo.io/reference/sync-report-metrics" target="_blank">Metrics and Dimensions Reference</a> for a complete list.
group_by body · required
The dimension to group results by (row dimension). Pass one object to break results down by that dimension. Pass an empty array <code>[]</code> for flat totals with no grouping. Only one entry is supported. Refer to the <a href="https://docs.apollo.io/reference/sync-report-metrics" target="_blank">Metrics and Dimensions Reference</a> for valid dimension names.
group_by_totals_selected body · required
When <code>true</code>, the response includes an aggregated totals row in addition to the per-dimension-value rows.
metrics body · required
The metrics to query. Each object specifies which metric to measure and which date and user columns the engine should use for that metric. The <code>smart_datetime_reference</code> and <code>smart_user_id_reference</code> values are metric-specific — using the wrong values will return no data. Refer to the <a href="https://docs.apollo.io/reference/sync-report-metrics" target="_blank">Metrics and Dimensions Reference</a> for valid metric names and the correct reference fields for each. <br...
min_ratio_denominator body · optional
Minimum denominator threshold for ratio metrics. Rows where the denominator falls below this value are excluded from ratio calculations.
pivot_group_by body · optional
The dimension to pivot on (column dimension). Used together with <code>group_by</code> to produce a two-dimensional cross-tab table: <code>group_by</code> defines the row dimension and <code>pivot_group_by</code> defines the column dimension. Pass an empty array <code>[]</code> for non-pivot queries. Only one entry is supported.
pivot_group_by_totals_selected body · required
When <code>true</code>, the pivot response includes an aggregated totals column in addition to the per-pivot-value columns.
skip_group_by_values body · optional
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.
sorts body · required
Sort order for the result rows. Only the first entry is applied. Pass an empty array <code>[]</code> to use the default order. Sorting is supported by metric value — provide the <code>metric</code> field with the same structure as an entry in the <code>metrics</code> array. The <code>asc</code> field controls direction (<code>true</code> = ascending, <code>false</code> = descending). Sorting by dimension value (e.g. alphabetically by user name) is not supported via the API.

Provider docs How to run it