GET /public/v1/analytics/overview

Get workspace-level analytics totals and per-campaign breakdown. Workspace admins and owners see all campaigns in the workspace, Workspace members see only their own campaigns.

GET /public/v1/analytics/overview
API key in header x-api-key

Query parameters

· 6
endDate string

Required. End of the date range in YYYY-MM-DD format (e.g. 2026-01-31). Must be on or after startDate.

granularity string · default: day· enum

Time bucket size for the time series. Defaults to day.

values

  • day
  • week
group_by string · default: campaign· enum

Dimension to group results by. Currently only "campaign" is supported.

values

  • campaign
ownerId string

Admin/Owner only: scope results to a specific workspace member by their user ID.

startDate string

Required. Start of the date range in YYYY-MM-DD format (e.g. 2026-01-01).

workspaceId string

Required. The workspace to scope the analytics to. Admins and owners see all campaigns; members see only their own.

Responses