Analytics

Break metrics down by email, sequence or recipient

Changed on

Returns the delivery funnel for each value of one dimension, most sends first, so you can find the email, sequence, provider or domain behind a number and drill into it. Rows count the sends made in the window and the engagement they earned. Defaults to the last 30 days and 25 rows.

get/metrics/breakdown

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/metrics/breakdown
  • Auth
    HTTP bearer

Query parameters

by'email' | 'sequence' | 'email_type' | 'mailbox_provider' | 'recipient_domain'

Dimension to group by. email has one row per campaign, sequence email step and transactional template.

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

Sliding window over send times. Ignored when start/end are provided.

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.

emailType'campaign' | 'transactional' | 'sequence'

Structural email type filter. Marketer-role personal keys only see the emails their role can open and cannot request transactional.

mailboxProviderstring

Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud).

recipientDomainstring

Recipient domain filter (e.g. gmail.com). Case-insensitive.

sourcestring

Email source filter as <type>:<id>: campaign:<campaignId>, sequence:<sequenceId>, sequence_step:<email step id> or transactional:<transactional email id>. Returns 404 when the source is not in the company or not visible to the key.

outcome'permanent_bounce' | 'temporary_bounce' | 'blocked' | 'complaint'

Only sends that had this outcome: a permanent bounce, a temporary bounce, a blocked bounce (the receiver refused it over content, policy or reputation) or a spam complaint. Matches the dashboard's Sender Quality cards. Filtered responses report replies as 0 and omit the commerce forecast.

limitinteger

Number of rows to return.

includeMachineEngagementboolean

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

Response

Success

successboolean required
bystring required
periodstring

Applied period, or custom when start/end were provided.

startstring date-time required
endstring date-time required
emailTypestring
mailboxProviderstring
recipientDomainstring
sourcestring
outcomestring

Example response

{
  "success": true,
  "by": "sequence",
  "rows": [
    {
      "key": "seq_123",
      "label": "Abandoned Checkout Recovery"
    }
  ]
}

Changes