In-App Campaign Stats

GET

api

in-app

campaigns

{campaignId}

stats

In-App Campaign Stats

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

import requests

url = "https://api.sequenzy.com/api/v1/in-app/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/in-app/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/in-app/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/in-app/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/in-app/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",
  "state": "live",
  "audienceAtLaunch": 1200,
  "stats": {
    "delivered": 860,
    "displayed": 812,
    "clicked": 214,
    "totalClicks": 251,
    "dismissed": 402,
    "pushPermissionGranted": 0,
    "pushPermissionDenied": 0,
    "buttons": []
  }
}

{
  "error": "Invalid API key"
}

{
  "error": "API key is missing required scope: campaigns:read"
}

{
  "error": "Campaign not found."
}

Returns reach and engagement for an in-app campaign, counted from the messages it delivered. Requires the campaigns:read scope.

delivered: contacts whose app received the message while they were in the audience.
displayed: contacts the app showed it to (impressions, once per contact).
clicked and totalClicks: contacts who clicked at least once, and every click.
dismissed: contacts who closed it.
pushPermissionGranted and pushPermissionDenied: for push primers, what contacts chose after the permission button.
buttons: for custom HTML messages, how many contacts’ first click hit each control (buttonId).

audienceAtLaunch is how many contacts matched the audience when it went live (for a scheduled campaign, counted again at go-live). Delivered can be lower (contacts who haven’t opened the app yet) or higher (contacts who joined the audience later).

Request

string

required

The in-app campaign ID.

curl -X GET "https://api.sequenzy.com/api/v1/in-app/campaigns/cmp_abc123/stats" \
  --header "Authorization: Bearer $SEQUENZY_API_KEY"

Responses

{
  "success": true,
  "campaignId": "cmp_abc123",
  "status": "sent",
  "state": "live",
  "audienceAtLaunch": 1200,
  "stats": {
    "delivered": 860,
    "displayed": 812,
    "clicked": 214,
    "totalClicks": 251,
    "dismissed": 402,
    "pushPermissionGranted": 0,
    "pushPermissionDenied": 0,
    "buttons": []
  }
}

{
  "error": "Invalid API key"
}

{
  "error": "API key is missing required scope: campaigns:read"
}

{
  "error": "Campaign not found."
}

In-App Campaign Stats

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

import requests

url = "https://api.sequenzy.com/api/v1/in-app/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/in-app/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/in-app/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/in-app/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/in-app/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",
  "state": "live",
  "audienceAtLaunch": 1200,
  "stats": {
    "delivered": 860,
    "displayed": 812,
    "clicked": 214,
    "totalClicks": 251,
    "dismissed": 402,
    "pushPermissionGranted": 0,
    "pushPermissionDenied": 0,
    "buttons": []
  }
}

{
  "error": "Invalid API key"
}

{
  "error": "API key is missing required scope: campaigns:read"
}

{
  "error": "Campaign not found."
}

​Request

​Responses

Request

Responses