Analytics

Get email client breakdown

Changed on

Returns the mail clients and device types that opened your emails, as shares of unique opens. Each email send counts once, attributed to the client of its first open. Defaults to the last 90 days.

get/metrics/clients

Request

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

Query parameters

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

Sliding window over open 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 see campaign and sequence email only and cannot request transactional.

mailboxProviderstring

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

includeMachineEngagementboolean

Include detected scanner, preview, and tracked asset opens.

Response

Success

successboolean required
periodstring required

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

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

Echoed back when mailboxProvider is provided.

startstring date-time
endstring date-time
totalOpensinteger required

Unique opens the breakdown covers. 0 when nothing was opened, in which case clients and devices are empty.

privacyProxyOpensinteger required

Opens through the Gmail or Yahoo image proxies or Apple Mail Privacy Protection, where the reader's device is unknown.

Example response

{
  "success": true,
  "period": "90d",
  "totalOpens": 200,
  "privacyProxyOpens": 150,
  "clients": [
    {
      "label": "Gmail",
      "opens": 100,
      "share": 50
    }
  ],
  "devices": [
    {
      "label": "Mobile",
      "opens": 50,
      "share": 25
    }
  ]
}

Changes