Messages

Retrieve a message export

GET/v1/messages/exports/{id}

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

The export's progress: queued, generating, then ready or failed. A ready file is kept until expiresAt, after which the export reads expired. A failed export says why in failureCode: EXPORT_TOO_LARGE (narrow the filters) or GENERATION_FAILED.

Path parameters

idstringrequired: uuid

Returns

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

idstringrequired

uuid

statusstringrequired

queued, generating, then ready or failed; expired once the file is deleted.

one of queued, generating, ready, failed, expired

rowCountinteger | nullrequired

Rows in the file, once it is ready.

min -9007199254740991 · max 9007199254740991

filtersMessageExportFiltersrequired

The filters the export was created with.

7 child attributes

statusstringoptional

Only messages in this status.

one of queued, sending, skipped, sent, failed, delivered, bounced, complained

channelstringoptional

Only messages on this channel.

one of email, push

recipientstringoptional

The exact address the message went to.

email · up to 320 characters

qstringoptional

Part of the recipient's email address or name, matched against the contact the message went to.

1–100 characters

messageTypestringoptional

Only messages of this type, such as campaign or transactional.

one of marketing, transactional

createdAfterstringoptional

Only messages accepted at or after this time (inclusive).

date-time

createdBeforestringoptional

Only messages accepted before this time (exclusive).

date-time

createdAtstringrequired

date-time

completedAtstring | nullrequired

date-time

expiresAtstring | nullrequired

When the file is deleted; the export then reads expired.

date-time

failureCodestring | nullrequired

EXPORT_TOO_LARGE or GENERATION_FAILED when status is failed.

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

const response = await fetch('https://api.kirora.io/v1/messages/exports/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b', {
  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/messages/exports/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
    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/messages/exports/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b", 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",
    "status": "queued",
    "rowCount": -9007199254740991,
    "filters": {},
    "createdAt": "2030-03-14T09:30:00Z",
    "completedAt": "2030-03-14T09:30:00Z",
    "expiresAt": "2030-03-14T09:30:00Z",
    "failureCode": "failureCode_example"
  }
}

Example values are generated from the schema.