Skip to main content
GET
Campaign analytics

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Campaign id.

Example:

"c1a2b3d4-..."

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

scope
enum<string>
default:family

Which emails and outcomes count. family (default): the campaign together with its subsequences – every email, reply and conversion is counted once, and a person is counted once. main: the main sequence only. To read a single subsequence, pass subsequenceId instead.

Available options:
family,
main
Example:

"family"

subsequenceId
string

Only this subsequence of the campaign: its emails and the replies, positive leads and conversions credited to it. Takes precedence over scope.

Example:

"b7e8f9a0-..."

breakdown
enum<string>[]

Extra breakdowns to include. Repeat the param or pass a comma-separated list. Each one costs an extra query, so ask only for what you will read.

Available options:
smtp,
sequence,
bounce
Example:

Response

campaignId
string
required
Example:

"c1a2b3d4-..."

period
object
required
totals
object
required
bySmtp
object[]

Present only when requested via breakdown=smtp.

bySequence
object[]

Present only when requested via breakdown=sequence.

bounceBreakdown
object

Present only when requested via breakdown=bounce.

subsequences
object[]

Present when the campaign has subsequences: per-subsequence counters, all time (not limited to the period). totals and the breakdowns follow scope / subsequenceId (the whole campaign by default).