Reports

Compare campaigns

GET/v1/reports/campaigns

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

One row per campaign with a marketing email sent, or a marketing push queued, in the window. Counts are send cohorts like the overview: email by the time it was sent, push by the time it was queued, and later feedback revises them. Conversions are those whose source message was sent in the window, and revenue is summed per goal currency, never converted. Rates are fractions; null means no denominator, and sorts below every rate. firstSentAt is the earliest send in the window, not the campaign schedule; sent sorts by email sent.

Query parameters

limitintegeroptional

min > 0 · max 100 · default 20

cursorstringoptional

1–2048 characters

startDatestringoptional

First day, inclusive, in the workspace timezone. Give with endDate.

date

endDatestringoptional

Last day, inclusive, no later than today. Give with startDate; a window is at most 366 days. Omit both for the last 30 days.

date

sortstringoptional

A field ascending, or -field descending. Rates with no denominator sort last.

one of firstSentAt, sent, openRate, clickRate, bounceRate, unsubscribeRate, conversions, -firstSentAt, -sent, -openRate, -clickRate, -bounceRate, -unsubscribeRate, -conversions · default "-firstSentAt"

Returns

Returns 200 OK with a list of CampaignPerformance objects in data, and the next page's cursor in meta (see pagination). Otherwise returns an error; Errors lists every code and which to retry.

campaignIdstringrequired

uuid

namestringrequired

statusstringrequired

one of draft, scheduled, sending, sent, cancelled

channelsstring[]required

The channels the campaign targets.

firstSentAtstringrequired

The earliest send in the window, not the campaign schedule.

date-time

emailobjectrequired

Email counts for the window.

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

ratesobjectrequired

Email rates as fractions; null when there is no denominator.

6 child attributes

deliverynumber | nullrequired: min 0
opennumber | nullrequired: min 0
clicknumber | nullrequired: min 0
bouncenumber | nullrequired: min 0
complaintnumber | nullrequired: min 0
unsubscribenumber | nullrequired: min 0

pushobjectrequired

Push counts for the window.

4 child attributes

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

conversionsintegerrequired

Goal conversions whose source message was sent in the window.

min 0 · max 9007199254740991

revenueobject[]required

Revenue per goal currency.

2 child attributes

currencystring | nullrequired: The goal currency; null when it has none.
valuenumberrequired: Revenue in that currency, never converted.

curl https://api.kirora.io/v1/reports/campaigns \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/reports/campaigns', {
  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/reports/campaigns",
    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/reports/campaigns", 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",
      "name": "Weekend specials",
      "status": "draft",
      "channels": [
        "email"
      ],
      "firstSentAt": "2030-03-14T09:30:00Z",
      "email": {
        "sent": 0,
        "delivered": 0,
        "opened": 0,
        "clicked": 0,
        "bounced": 0,
        "complained": 0,
        "unsubscribed": 0
      },
      "rates": {
        "delivery": 0,
        "open": 0,
        "click": 0,
        "bounce": 0,
        "complaint": 0,
        "unsubscribe": 0
      },
      "push": {
        "sent": 0,
        "failed": 0,
        "opened": 0,
        "clicked": 0
      },
      "conversions": 0,
      "revenue": [
        {
          "currency": "USD",
          "value": 1
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}

Example values are generated from the schema.