Get campaign analytics

GET

/api/v2/flare/campaigns/{id}/analytics

curl --request GET \
  --url https://api.sipstack.com/api/v2/flare/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/analytics \
  --header 'x-api-key: <x-api-key>'

import requests

url = "https://api.sipstack.com/api/v2/flare/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/analytics"

headers = {"x-api-key": "<x-api-key>"}

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

print(response.json())

const url = 'https://api.sipstack.com/api/v2/flare/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/analytics';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.sipstack.com/api/v2/flare/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/analytics',
  headers: {'x-api-key': '<x-api-key>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Returns a real-time delivery rollup for the campaign (counts, rates, opt-outs, and a link-click rollup when link tracking is on). Requires sms:read.

Authorizations

apiKeyAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

The analytics rollup.

application/json

object

success

boolean

data

Real-time delivery rollup for a campaign. Rate fields are percentage strings with two decimals.

object

totalMessages

integer

totalRecipients

integer

queued

integer

sending

integer

sent

integer

pending

Alias of sent — sent but awaiting delivery confirmation.

integer

delivered

integer

failed

integer

undelivered

integer

bounced

Alias of undelivered.

integer

replies

integer

optOuts

integer

uniqueResponders

integer

deliveryRate

Delivered ÷ attempted (#6435): attempted = delivered + failed + undelivered + sent/sending; queued and cancelled excluded.

string

failureRate

(failed + undelivered) ÷ attempted.

string

attempted

Delivered + failed + undelivered + sent/sending — the rate denominator.

integer

awaiting

Sent within the last 72 hours, no delivery receipt yet.

integer

noReceipt

Sent more than 72 hours ago; the carrier never confirmed delivery. Still counted as attempted.

integer

provisional

True while awaiting is above 0 — the rate can still change.

boolean

responseRate

string

optOutRate

string

progress

string

trackLinks

boolean

linkAnalytics

Click rollup — a zero-valued shape when link tracking is off.

object

totalClicks

integer

uniqueClicks

integer

uniqueClickedLinks

integer

topLinks

Array<object>

object

key

additional properties

any

Example

{
  "data": {
    "deliveryRate": "98.20",
    "failureRate": "1.80",
    "responseRate": "4.10",
    "optOutRate": "0.30",
    "progress": "100.00"
  }
}

401

Missing or invalid API key.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}

404

Campaign not found in your organization.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}