Campaigns

Chart campaign performance over time

GET/v1/campaigns/{id}/series

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

Counts of each delivery and engagement event per hour or per day in the workspace's timezone (timezone), split by channel. An event lands in the bucket in which it happened: an open at 10:05 counts in the 10:00 hour. Opens and clicks are the first per message, as in the stats. Buckets start at the first send and run without gaps to the current one, up to 72 hours or 366 days; events after that are outside the series. A campaign that has not sent returns no points. Each bucket counts events, not a cohort, so a per-bucket open rate means nothing — divide running totals instead.

Path parameters

idstringrequired: uuid

Query parameters

intervalstringrequired

The bucket size.

one of hour, day

Returns

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

campaignIdstringrequired

uuid

intervalstringrequired

The bucket size.

one of hour, day

timezonestring | nullrequired

The workspace timezone buckets follow; null when the campaign has not sent.

pointsobject[]required

One point per bucket, from the first send to the current one.

at most 366 items

2 child attributes

datestringrequired

Start of the bucket: a local hour or midnight in timezone, as an instant.

date-time

byChannelobjectrequired

Event counts per channel; a channel the campaign skips is absent.

2 child attributes

emailobjectoptional

7 child attributes

sentintegerrequired: min 0 · max 9007199254740991
deliveredintegerrequired: min 0 · max 9007199254740991
openedintegerrequired: min 0 · max 9007199254740991
clickedintegerrequired: min 0 · max 9007199254740991
bouncedintegerrequired: min 0 · max 9007199254740991
complainedintegerrequired: min 0 · max 9007199254740991
unsubscribedintegerrequired: min 0 · max 9007199254740991

pushobjectoptional

4 child attributes

sentintegerrequired: min 0 · max 9007199254740991
failedintegerrequired: min 0 · max 9007199254740991
openedintegerrequired: min 0 · max 9007199254740991
clickedintegerrequired: min 0 · max 9007199254740991

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

const response = await fetch('https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/series?interval=hour', {
  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/series?interval=hour",
    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/series?interval=hour", 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",
    "interval": "hour",
    "timezone": "Europe/London",
    "points": [
      {
        "date": "2030-03-14T09:30:00Z",
        "byChannel": {}
      }
    ]
  }
}

Example values are generated from the schema.