Push

List a push message's deliveries

GET/v1/push/messages/{id}/deliveries

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

What each device answered for one push message (id from the send). A push reaches every ready installation of the contact, so a message has one delivery per device. accepted: Apple, Google or the browser's push service took it, which is not proof the device showed it. invalid: the device is gone and its installation was retired. rejected: refused, often the app's key or a payload the provider would not take. retryable: will be tried again. unknown: the provider may have taken it, so it is not resent. skipped: not attempted, as when the app's key was refused for another device of the same app. pending and started are still in flight. A message that is not a push answers 404.

Path parameters

idstringrequired: uuid

Query parameters

limitintegeroptional: min > 0 · max 100 · default 20
cursorstringoptional: 1–2048 characters

Returns

Returns 200 OK with a list of PushDelivery 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.

idstringrequired

uuid

installationIdstringrequired

The device the delivery went to.

uuid

platformstringrequired

one of ios, android, web

statusstringrequired

one of pending, started, accepted, invalid, rejected, retryable, unknown, skipped

attemptCountintegerrequired

Times sending was tried.

min 0 · max 9007199254740991

startedAtstring | nullrequired

When the first attempt began.

date-time

resolvedAtstring | nullrequired

When it reached a final status.

date-time

createdAtstringrequired

date-time

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

const response = await fetch('https://api.kirora.io/v1/push/messages/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/deliveries', {
  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/push/messages/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/deliveries",
    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/push/messages/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/deliveries", 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": [
    {
      "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
      "installationId": "018f2a4e-6b1c-7d3e-9f40-682349985a6b",
      "platform": "ios",
      "status": "pending",
      "attemptCount": 0,
      "startedAt": "2030-03-14T09:30:00Z",
      "resolvedAt": "2030-03-14T09:30:00Z",
      "createdAt": "2030-03-14T09:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}

Example values are generated from the schema.