latestOpenAPI 3.0.32026-08-23640164.5 KB

1d888a894943

Analytics

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

Query parameters

startDatestring

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

endDatestring

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

workspaceIdstring

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

group_by'campaign'

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

granularity'day' | 'week'

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

ownerIdstring

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

Response

Default Response

statusCodenumber
statusboolean
messagestring