Sign in

v101

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-08235133843.7 KB
Analytics

List per-email metrics

Returns one row per email - each campaign and each sequence email step - with its own delivery funnel, attributed conversions, and revenue. Sequence rows carry sequenceId, automationNodeId, and the step number, so cross-sequence questions such as how many step-4 emails went out are one request instead of one per sequence. Counts come from retained event storage and match the steps array of the sequence metrics endpoint. The totals object covers every matching email rather than the current page.

get/metrics/emails

Query parameters

emailType'campaign' | 'sequence'

Restrict to campaigns or sequence emails. Defaults to both. Implied as sequence when sequenceId or step is set, and as campaign when campaignId is set.

sequenceIdstring
Example:seq_abc123,seq_def456

Comma-separated sequence IDs to restrict the breakdown to. Cannot be combined with campaignId or emailType=campaign.

campaignIdstring
Example:camp_abc123,camp_def456

Comma-separated campaign IDs to restrict the breakdown to. Cannot be combined with sequenceId, step, or emailType=sequence.

stepinteger

Keep only sequence emails at this 1-based position, counted in graph order per sequence. Cannot be combined with emailType=campaign.

period'1h' | '24h' | '7d' | '30d' | '90d'

Sliding time window. Ignored when start/end are provided. Omit both for all-time counts.

startstring date-time

Start of custom time range (ISO 8601). Must be used with end.

endstring date-time

End of custom time range (ISO 8601). Must be used with start. Max range: 90 days.

sort'sent' | 'delivered' | 'opened' | 'clicked' | 'openRate' | 'clickRate' | 'unsubscribed' | 'conversions' | 'revenue' | 'step' | 'name'

Sort field.

order'asc' | 'desc'

Sort order.

pageinteger

Page number.

limitinteger

Emails per page.

includeMachineEngagementboolean

Include detected scanner, preview, and tracked asset open/click events in engagement metrics.

Response

Success

successboolean
periodstring
startstring date-time
endstring date-time
emailType'campaign' | 'sequence'
stepinteger

Echo of the step filter, present only when one was requested.

sequenceIdsstring[]

Echo of the sequence IDs the breakdown was scoped to.

sortstring
orderstring
totalsobject

Summed funnel across every matching email, not just this page, plus emails, conversions, and revenueCents.

Example response

{
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "totalPages": 5
  }
}