Analytics

Get aggregated email metrics

Returns aggregated email engagement metrics for the specified time period, plus live subscriberCount (every stored contact) and activeSubscriberCount (status=active) as an audience snapshot independent of period. Set emailType=transactional for Send API and transactional SMTP traffic.

get/metrics

Request

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

Query parameters

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

Sliding time window. 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. Use transactional for Send API and transactional SMTP traffic.

mailboxProviderstring

Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud). Scopes engagement metrics to recipients of that provider. Provider-filtered responses report replies as 0 (replies cannot be segmented per provider) and omit the commerce forecast.

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>. Responses filtered by recipientDomain or source report replies as 0 and omit the commerce forecast. 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.

includeMachineEngagementboolean

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

Response

Success

successboolean
periodstring
emailType'campaign' | 'transactional' | 'sequence'
mailboxProviderstring

Echoed back when mailboxProvider is provided.

recipientDomainstring

Echoed back, lowercased, when recipientDomain is provided.

sourcestring

Echoed back when source is provided.

outcomestring

Echoed back when outcome is provided.

subscriberCountinteger

Live count of every stored contact in the company. Independent of the requested period.

activeSubscriberCountinteger

Live count of contacts with status=active. Independent of the requested period. May include phone-only contacts without an email address.

Example response

{
  "commerceForecast": {
    "modelVersion": "cohort-rfm-v1"
  }
}

Changes