Analytics

Get campaign email client breakdown

Changed on

Returns the mail clients and device types that opened a campaign, as shares of its unique opens. Each email send counts once, attributed to the client of its first open. Covers the whole campaign.

get/metrics/campaigns/{campaignId}/clients

Request

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

Path parameters

campaignIdstring required

Email campaign ID.

Query parameters

mailboxProviderstring

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

includeMachineEngagementboolean

Include detected scanner, preview, and tracked asset opens.

Response

Success

successboolean required
campaignIdstring required
mailboxProviderstring

Echoed back when mailboxProvider is provided.

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,
  "totalOpens": 200,
  "privacyProxyOpens": 150,
  "clients": [
    {
      "label": "Gmail",
      "opens": 100,
      "share": 50
    }
  ],
  "devices": [
    {
      "label": "Mobile",
      "opens": 50,
      "share": 25
    }
  ]
}

Changes