Push
Get Push Campaign Stats
Read delivery and engagement stats for a push campaign
GET
/
api
/
v1
/
push
/
campaigns
/
{campaignId}
/
stats
Get Push Campaign Stats
curl --request GET \
--url https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}/stats \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}/stats"
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/push/campaigns/{campaignId}/stats', 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/push/campaigns/{campaignId}/stats",
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/push/campaigns/{campaignId}/stats"
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))
}HttpResponse<String> response = Unirest.get("https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}/stats")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}/stats")
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": "cmp_abc123",
"status": "sent",
"stats": {
"total": 340,
"pending": 0,
"sent": 331,
"failed": 4,
"skipped": 5,
"delivered": 210,
"clicked": 48,
"devicesTargeted": 402,
"devicesAccepted": 389,
"skipReasons": [
{
"reason": "no_active_device",
"count": 5
}
],
"failureReasons": [
{
"reason": "all_devices_invalid",
"count": 4
}
]
}
}
{
"error": "This campaign is not a push campaign."
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: campaigns:read"
}
{
"error": "Campaign not found."
}
Get Push Campaign Stats
Returns delivery and engagement stats for a push campaign. Test sends are excluded.| Field | Meaning |
|---|---|
sent | Contacts whose notification at least one push service accepted |
delivered | Contacts whose device reported displaying it (browsers report automatically; apps report through the events endpoint) |
clicked | Contacts who opened it |
failed | Contacts whose every device rejected it, or whose credentials were refused |
skipped | Contacts with no active device on a set-up platform, or stopped by a cancel |
devicesTargeted / devicesAccepted | Device-level counts |
campaigns:read scope.
Request
string
required
The push campaign ID.
curl "https://api.sequenzy.com/api/v1/push/campaigns/cmp_abc123/stats" \
--header "Authorization: Bearer $SEQUENZY_API_KEY"
Responses
{
"success": true,
"campaignId": "cmp_abc123",
"status": "sent",
"stats": {
"total": 340,
"pending": 0,
"sent": 331,
"failed": 4,
"skipped": 5,
"delivered": 210,
"clicked": 48,
"devicesTargeted": 402,
"devicesAccepted": 389,
"skipReasons": [
{
"reason": "no_active_device",
"count": 5
}
],
"failureReasons": [
{
"reason": "all_devices_invalid",
"count": 4
}
]
}
}
{
"error": "This campaign is not a push campaign."
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: campaigns:read"
}
{
"error": "Campaign not found."
}
⌘I
Get Push Campaign Stats
curl --request GET \
--url https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}/stats \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}/stats"
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/push/campaigns/{campaignId}/stats', 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/push/campaigns/{campaignId}/stats",
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/push/campaigns/{campaignId}/stats"
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))
}HttpResponse<String> response = Unirest.get("https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}/stats")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/push/campaigns/{campaignId}/stats")
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": "cmp_abc123",
"status": "sent",
"stats": {
"total": 340,
"pending": 0,
"sent": 331,
"failed": 4,
"skipped": 5,
"delivered": 210,
"clicked": 48,
"devicesTargeted": 402,
"devicesAccepted": 389,
"skipReasons": [
{
"reason": "no_active_device",
"count": 5
}
],
"failureReasons": [
{
"reason": "all_devices_invalid",
"count": 4
}
]
}
}
{
"error": "This campaign is not a push campaign."
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: campaigns:read"
}
{
"error": "Campaign not found."
}