Skip to main content
GET
Workspace analytics roll-up

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

startDate
string

Start of the reporting window (ISO-8601). ⚠️ Reporting is by whole calendar day in your workspace timezone – the time component is ignored, so this date counts from the START of that day.

Example:

"2026-06-01T00:00:00Z"

endDate
string

End of the reporting window (ISO-8601). Defaults to now. ⚠️ Inclusive and by whole calendar day (time component ignored) – this counts through the END of that day in your workspace timezone.

Example:

"2026-06-30T23:59:59Z"

excludeOOO
boolean
default:false

Exclude out-of-office auto-replies from reply counts and reply rate. Mirrors the dashboard toggle.

Example:

true

Response

period
object
required
totals
object
required

Rolled up across every campaign in the workspace.

activeCampaigns
number
required

Campaigns currently sending.

Example:

7

sendingAccounts
number
required

Connected sending accounts.

Example:

12

topCampaigns
object[]
required

Highest-volume campaigns in the window.