Campaigns

Retrieve campaign statistics

GET/v1/campaigns/{id}/stats

Requires an API key with the campaigns:read scope. About keys and scopes

Aggregate delivery and engagement counters for one campaign. The top-level counters span every channel, so they count messages: an email-and-push campaign to 100 people reports sent: 200. Use recipients for people and byChannel for each channel. Counters continue to move after a send completes, as opens, clicks and bounces arrive.

Path parameters

idstringrequired: uuid

Returns

Returns 200 OK with a CampaignStats in data. Otherwise returns an error; Errors lists every code and which to retry.

campaignIdstringrequired

uuid

recipientsintegerrequired

People the campaign went to.

min 0 · max 9007199254740991

queuedintegerrequired

Messages waiting to be sent.

min 0 · max 9007199254740991

sendingintegerrequired

Messages being handed to the provider.

min 0 · max 9007199254740991

skippedintegerrequired

Messages not sent; see skippedByReason.

min 0 · max 9007199254740991

sentintegerrequired

Messages handed to the provider.

min 0 · max 9007199254740991

failedintegerrequired

Messages that could not be sent.

min 0 · max 9007199254740991

deliveredintegerrequired

Messages confirmed delivered.

min 0 · max 9007199254740991

bouncedintegerrequired

Messages the recipient server rejected.

min 0 · max 9007199254740991

complainedintegerrequired

Messages the recipient marked as spam.

min 0 · max 9007199254740991

openedintegerrequired

Messages opened at least once.

min 0 · max 9007199254740991

clickedintegerrequired

Messages with a link clicked at least once.

min 0 · max 9007199254740991

unsubscribedintegerrequired

Recipients who opted out through this campaign's link.

min 0 · max 9007199254740991

totalintegerrequired

All messages created.

min 0 · max 9007199254740991

byChannelobjectrequired

The same counters per channel; a channel the campaign skips is absent.

2 child attributes

emailCampaignMessageCountsoptional

12 child attributes

queuedintegerrequired

Messages waiting to be sent.

min 0 · max 9007199254740991

sendingintegerrequired

Messages being handed to the provider.

min 0 · max 9007199254740991

skippedintegerrequired

Messages not sent; see skippedByReason.

min 0 · max 9007199254740991

sentintegerrequired

Messages handed to the provider.

min 0 · max 9007199254740991

failedintegerrequired

Messages that could not be sent.

min 0 · max 9007199254740991

deliveredintegerrequired

Messages confirmed delivered.

min 0 · max 9007199254740991

bouncedintegerrequired

Messages the recipient server rejected.

min 0 · max 9007199254740991

complainedintegerrequired

Messages the recipient marked as spam.

min 0 · max 9007199254740991

openedintegerrequired

Messages opened at least once.

min 0 · max 9007199254740991

clickedintegerrequired

Messages with a link clicked at least once.

min 0 · max 9007199254740991

unsubscribedintegerrequired

Recipients who opted out through this campaign's link.

min 0 · max 9007199254740991

totalintegerrequired

All messages created.

min 0 · max 9007199254740991

pushCampaignMessageCountsoptional

12 child attributes

queuedintegerrequired

Messages waiting to be sent.

min 0 · max 9007199254740991

sendingintegerrequired

Messages being handed to the provider.

min 0 · max 9007199254740991

skippedintegerrequired

Messages not sent; see skippedByReason.

min 0 · max 9007199254740991

sentintegerrequired

Messages handed to the provider.

min 0 · max 9007199254740991

failedintegerrequired

Messages that could not be sent.

min 0 · max 9007199254740991

deliveredintegerrequired

Messages confirmed delivered.

min 0 · max 9007199254740991

bouncedintegerrequired

Messages the recipient server rejected.

min 0 · max 9007199254740991

complainedintegerrequired

Messages the recipient marked as spam.

min 0 · max 9007199254740991

openedintegerrequired

Messages opened at least once.

min 0 · max 9007199254740991

clickedintegerrequired

Messages with a link clicked at least once.

min 0 · max 9007199254740991

unsubscribedintegerrequired

Recipients who opted out through this campaign's link.

min 0 · max 9007199254740991

totalintegerrequired

All messages created.

min 0 · max 9007199254740991

pushobject | nullrequired

Device-level outcomes. null when the campaign does not target push.

10 child attributes

pendingintegerrequired

Devices not yet attempted.

min 0 · max 9007199254740991

startedintegerrequired

Devices being sent to now.

min 0 · max 9007199254740991

acceptedintegerrequired

Devices the push service accepted.

min 0 · max 9007199254740991

invalidintegerrequired

Devices whose registration is no longer valid.

min 0 · max 9007199254740991

rejectedintegerrequired

Devices the push service permanently refused.

min 0 · max 9007199254740991

retryableintegerrequired

Devices that failed temporarily and will be retried.

min 0 · max 9007199254740991

unknownintegerrequired

Devices whose outcome could not be determined.

min 0 · max 9007199254740991

skippedintegerrequired

Devices not sent to.

min 0 · max 9007199254740991

totalintegerrequired

All devices targeted.

min 0 · max 9007199254740991

byPlatformobjectrequired

3 child attributes

iosobjectoptional

9 child attributes

pendingintegerrequired

Devices not yet attempted.

min 0 · max 9007199254740991

startedintegerrequired

Devices being sent to now.

min 0 · max 9007199254740991

acceptedintegerrequired

Devices the push service accepted.

min 0 · max 9007199254740991

invalidintegerrequired

Devices whose registration is no longer valid.

min 0 · max 9007199254740991

rejectedintegerrequired

Devices the push service permanently refused.

min 0 · max 9007199254740991

retryableintegerrequired

Devices that failed temporarily and will be retried.

min 0 · max 9007199254740991

unknownintegerrequired

Devices whose outcome could not be determined.

min 0 · max 9007199254740991

skippedintegerrequired

Devices not sent to.

min 0 · max 9007199254740991

totalintegerrequired

All devices targeted.

min 0 · max 9007199254740991

androidobjectoptional

9 child attributes

pendingintegerrequired

Devices not yet attempted.

min 0 · max 9007199254740991

startedintegerrequired

Devices being sent to now.

min 0 · max 9007199254740991

acceptedintegerrequired

Devices the push service accepted.

min 0 · max 9007199254740991

invalidintegerrequired

Devices whose registration is no longer valid.

min 0 · max 9007199254740991

rejectedintegerrequired

Devices the push service permanently refused.

min 0 · max 9007199254740991

retryableintegerrequired

Devices that failed temporarily and will be retried.

min 0 · max 9007199254740991

unknownintegerrequired

Devices whose outcome could not be determined.

min 0 · max 9007199254740991

skippedintegerrequired

Devices not sent to.

min 0 · max 9007199254740991

totalintegerrequired

All devices targeted.

min 0 · max 9007199254740991

webobjectoptional

9 child attributes

pendingintegerrequired

Devices not yet attempted.

min 0 · max 9007199254740991

startedintegerrequired

Devices being sent to now.

min 0 · max 9007199254740991

acceptedintegerrequired

Devices the push service accepted.

min 0 · max 9007199254740991

invalidintegerrequired

Devices whose registration is no longer valid.

min 0 · max 9007199254740991

rejectedintegerrequired

Devices the push service permanently refused.

min 0 · max 9007199254740991

retryableintegerrequired

Devices that failed temporarily and will be retried.

min 0 · max 9007199254740991

unknownintegerrequired

Devices whose outcome could not be determined.

min 0 · max 9007199254740991

skippedintegerrequired

Devices not sent to.

min 0 · max 9007199254740991

totalintegerrequired

All devices targeted.

min 0 · max 9007199254740991

skippedByReasonobjectrequired

Skipped messages by reason, such as message_limit; they sum to skipped.

curl https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/stats \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/stats', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

response = requests.get(
    "https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/stats",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
data = response.json()["data"]

package main

import (
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/stats", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": {
    "campaignId": "018f2a4e-6b1c-7d3e-9f40-3478765e5a6b",
    "recipients": 0,
    "queued": 0,
    "sending": 0,
    "skipped": 0,
    "sent": 0,
    "failed": 0,
    "delivered": 0,
    "bounced": 0,
    "complained": 0,
    "opened": 0,
    "clicked": 0,
    "unsubscribed": 0,
    "total": 0,
    "byChannel": {},
    "push": {
      "pending": 0,
      "started": 0,
      "accepted": 0,
      "invalid": 0,
      "rejected": 0,
      "retryable": 0,
      "unknown": 0,
      "skipped": 0,
      "total": 0,
      "byPlatform": {}
    },
    "skippedByReason": {}
  }
}

Example values are generated from the schema.