Get Campaign Email Client Breakdown

GET

api

metrics

campaigns

{campaignId}

clients

Get Campaign Email Client Breakdown

curl --request GET \
  --url https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}/clients \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}/clients"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}/clients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}/clients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}/clients"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "campaignId": "camp_abc123",
  "totalOpens": 420,
  "privacyProxyOpens": 310,
  "clients": [
    { "key": "apple_mail", "label": "Apple Mail", "opens": 210, "share": 50 },
    { "key": "gmail", "label": "Gmail", "opens": 168, "share": 40 },
    { "key": "outlook", "label": "Outlook", "opens": 42, "share": 10 }
  ],
  "devices": [
    { "key": "unknown", "label": "Unknown", "opens": 310, "share": 73.80952380952381 },
    { "key": "mobile", "label": "Mobile", "opens": 70, "share": 16.666666666666668 },
    { "key": "desktop", "label": "Desktop", "opens": 40, "share": 9.523809523809524 }
  ]
}

{
  "success": false,
  "error": "This is an SMS campaign. SMS campaigns are managed from the dashboard; this endpoint only supports email campaigns."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Campaign not found"
}

Returns the mail clients and device types that opened one email campaign, as shares of its unique opens. The breakdown covers the whole campaign. Each email send counts once, attributed to the client of its first open. Test sends are excluded, and detected email-security scanners are excluded unless you set includeMachineEngagement=true. For every email in a time window, use Get Email Client Breakdown.

Path Parameters

string

required

The ID of an email campaign. SMS campaigns return 400.

Query Parameters

string

Optional recipient mailbox provider filter, for example gmail, microsoft, yahoo, or icloud.

boolean

default:"false"

Set to true to include detected scanner, preview, and tracked asset opens.

Response Fields

string

The campaign the breakdown covers.

number

Unique opens of the campaign. 0 when nothing was opened, in which case clients and devices are empty arrays.

number

Opens that came through the Gmail or Yahoo image proxies or Apple Mail Privacy Protection, which hide the reader’s device.

array

Mail clients, most opens first. Each item has key, label, opens, and share (percentage of totalOpens, not rounded). key is one of apple_mail, gmail, outlook, yahoo_mail, thunderbird, android_mail_app, web_browser, or other.

array

Device types, most opens first. key is one of desktop, mobile, tablet, or unknown.

mailboxProvider is echoed back when you provide it.

curl "https://api.sequenzy.com/api/v1/metrics/campaigns/camp_abc123/clients" \
  -H "Authorization: Bearer YOUR_API_KEY"

Responses

{
  "success": true,
  "campaignId": "camp_abc123",
  "totalOpens": 420,
  "privacyProxyOpens": 310,
  "clients": [
    { "key": "apple_mail", "label": "Apple Mail", "opens": 210, "share": 50 },
    { "key": "gmail", "label": "Gmail", "opens": 168, "share": 40 },
    { "key": "outlook", "label": "Outlook", "opens": 42, "share": 10 }
  ],
  "devices": [
    { "key": "unknown", "label": "Unknown", "opens": 310, "share": 73.80952380952381 },
    { "key": "mobile", "label": "Mobile", "opens": 70, "share": 16.666666666666668 },
    { "key": "desktop", "label": "Desktop", "opens": 40, "share": 9.523809523809524 }
  ]
}

{
  "success": false,
  "error": "This is an SMS campaign. SMS campaigns are managed from the dashboard; this endpoint only supports email campaigns."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Campaign not found"
}

Get Campaign Email Client Breakdown

curl --request GET \
  --url https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}/clients \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}/clients"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}/clients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}/clients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}/clients"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "campaignId": "camp_abc123",
  "totalOpens": 420,
  "privacyProxyOpens": 310,
  "clients": [
    { "key": "apple_mail", "label": "Apple Mail", "opens": 210, "share": 50 },
    { "key": "gmail", "label": "Gmail", "opens": 168, "share": 40 },
    { "key": "outlook", "label": "Outlook", "opens": 42, "share": 10 }
  ],
  "devices": [
    { "key": "unknown", "label": "Unknown", "opens": 310, "share": 73.80952380952381 },
    { "key": "mobile", "label": "Mobile", "opens": 70, "share": 16.666666666666668 },
    { "key": "desktop", "label": "Desktop", "opens": 40, "share": 9.523809523809524 }
  ]
}

{
  "success": false,
  "error": "This is an SMS campaign. SMS campaigns are managed from the dashboard; this endpoint only supports email campaigns."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Campaign not found"
}