Retrieve a journey's metricsMenu

Retrieve a journey's metrics

GET/v1/journeys/{id}/metrics

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

Works with integration, agent and partner keys.

Enrollments, messages and conversions for one journey over the report window (from inclusive, to exclusive, the last 30 days by default), counted by when each thing happened: an enrollment in the window started in it, wherever it is now. active is now. exited includes conversionGoalReached, the enrollments that left by reaching a conversion goal. messages counts what failed or was skipped; conversions gives each conversion goal of the journey its conversions and gross revenue (before refunds), credited to its messages. For where people are step by step, use GET /v1/journeys/{id}/step-metrics. Deleting a contact deletes their runs of the journey and those messages, so a past window can later show less than it did.

Path parameters

idstringrequired

The journey's id.

uuid

Query parameters

fromstringoptional: Start of the window, inclusive: a date-time, or a date meaning the start of that day in the workspace timezone. Give with to; omit both for the last 30 days.
tostringoptional: End of the window, exclusive, in the same forms. To include a whole last day, pass the day after it: from=2026-10-01&to=2026-10-08 covers 1 to 7 October. No later than the end of today; a window touches at most 366 days. Give with from.

Header parameters

Kirora-Workspacestringoptional

Partner keys only: the child workspace to act in, by the external id the partner gave it. Without it, a partner key acts in its own workspace. Any other key that sends it is refused with 403, and an unknown workspace is 404.

pattern ^[A-Za-z0-9._:-]{1,128}$

Returns

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

enrolledintegerrequired

Enrollments started.

min 0

activeintegerrequired

Enrollments in progress now.

min 0

completedintegerrequired

Enrollments that reached the end.

min 0

exitedintegerrequired

Enrollments ended early: by an exit event, a conversion goal, a filter, by hand or as the journey ended.

min 0

conversionGoalReachedintegerrequired

Of exited, those that left by reaching a conversion goal (a conversion_goal exit).

min 0

emailJourneyEmailCountsrequired

The journey's email messages created in the window (history.from to history.to), across every version of its steps.

15 child attributes

createdintegerrequired

Messages created.

min 0

queuedintegerrequired

Waiting to be sent.

min 0

sendingintegerrequired

Being handed to the provider.

min 0

failedintegerrequired

Could not be sent.

min 0

skippedintegerrequired

Not sent, such as for a missing consent or a limit.

min 0

sentintegerrequired

Handed to the provider, whatever happened after.

min 0

deliveredintegerrequired

Confirmed delivered, whatever happened after; test sends to [email protected] included (see simulated).

min 0

bouncedintegerrequired

Rejected by the recipient server; a test send to [email protected] is not counted.

min 0

complainedintegerrequired

Marked as spam by the recipient; a test send to [email protected] is not counted.

min 0

openedintegerrequired

Opened at least once.

min 0

openedByMachineintegerrequired

Of opened, those only a machine opened: a mail app fetched its images with no reader (Apple Mail Privacy Protection, Gmail's prefetch on delivery) or a mail security scanner checked it.

min 0

clickedintegerrequired

With a link clicked at least once, by a person.

min 0

clickedByMachineintegerrequired

Whose links a machine followed, such as a mail security scanner; counted in neither clicked nor opened.

min 0

unsubscribedintegerrequired

Whose recipient opted out through the email's link.

min 0

simulatedintegerrequired

Of sent, test sends whose outcome was acted out: those to delivered@, bounce@ or [email protected] (the transactional guide's "Test addresses"). The bounce and complaint rates leave them out.

min 0

pushJourneyPushCountsrequired

The journey's push messages created in the window, across every version of its steps.

8 child attributes

createdintegerrequired

Messages created.

min 0

queuedintegerrequired

Waiting to be sent.

min 0

sendingintegerrequired

Being handed to the provider.

min 0

failedintegerrequired

Could not be sent.

min 0

skippedintegerrequired

Not sent, such as for a missing consent or a limit.

min 0

sentintegerrequired

Handed to the provider, whatever happened after.

min 0

openedintegerrequired

Opened at least once.

min 0

clickedintegerrequired

With a link clicked at least once, by a person.

min 0

messagesobjectrequired

The journey's messages created in the window that did not go out.

2 child attributes

failedintegerrequired

Messages that could not be sent, all channels.

min 0

skippedintegerrequired

Messages not sent (no consent, suppressed, over a message limit), all channels. Some skips are expected, so this alone need not mean a problem.

min 0

conversionsJourneyConversions[]required

Per conversion goal of the journey, conversions in the window credited to its messages.

4 child attributes

conversionGoalobjectrequired

The conversion goal.

2 child attributes

idstringrequired: uuid
eventNamestringrequired: The event the conversion goal counts.

countintegerrequired

Conversions credited to the journey's messages.

min 0

revenueobject | nullrequired

The total of the goal's value; null when it reads no value, or when withheld.

2 child attributes

currencystring | nullrequired

The goal's currency; null when it names none.

valuenumberrequired

Gross, before refunds.

min 0

revenueWithheldbooleanrequired

True when the goal's value property is a masked attribute this viewer may not see, so revenue is null.

historyobjectrequired

Counts per day over the report window.

5 child attributes

fromstringrequired

Start of the window, inclusive.

date-time

tostringrequired

End of the window, exclusive.

date-time

timezonestringrequired

The workspace timezone the days are in.

basis"event_time"required

Days are counted by when each event happened.

seriesobject[]required

One entry per day in the window.

4 child attributes

startsAtstringrequired

When this day starts in timezone, given as an instant.

date-time

enrolledintegerrequired

Enrollments started that day.

min 0

completedintegerrequired

Enrollments that reached the end that day.

min 0

exitedintegerrequired

Enrollments ended early that day.

min 0

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

const response = await fetch('https://api.kirora.io/v1/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/metrics', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
if (!response.ok) throw new Error(`Kirora API ${response.status}: ${await response.text()}`);
const { data } = await response.json();

import os

import requests

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

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/metrics", 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()
	if res.StatusCode >= 300 {
		msg, _ := io.ReadAll(res.Body)
		panic(fmt.Sprintf("Kirora API %d: %s", res.StatusCode, msg))
	}

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

using System.Net.Http.Headers;
using System.Text.Json;

using var http = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.kirora.io/v1/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/metrics");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("KIRORA_API_KEY"));

using var response = await http.SendAsync(request);
if (!response.IsSuccessStatusCode)
    throw new HttpRequestException($"Kirora API {(int)response.StatusCode}: {await response.Content.ReadAsStringAsync()}");

using var document = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
var data = document.RootElement.GetProperty("data");

Response · 200

{
  "data": {
    "enrolled": 128,
    "active": 12,
    "completed": 114,
    "exited": 2,
    "conversionGoalReached": 1,
    "email": {
      "created": 240,
      "queued": 0,
      "sending": 0,
      "failed": 2,
      "skipped": 6,
      "sent": 232,
      "delivered": 228,
      "bounced": 4,
      "complained": 0,
      "opened": 131,
      "openedByMachine": 38,
      "clicked": 29,
      "clickedByMachine": 3,
      "unsubscribed": 1,
      "simulated": 0
    },
    "push": {
      "created": 0,
      "queued": 0,
      "sending": 0,
      "failed": 0,
      "skipped": 0,
      "sent": 0,
      "opened": 0,
      "clicked": 0
    },
    "messages": {
      "failed": 2,
      "skipped": 6
    },
    "conversions": [
      {
        "conversionGoal": {
          "id": "0192f3d0-7a1b-7c2d-8e3f-4a5b6c7d8e9f",
          "eventName": "Order Completed"
        },
        "count": 9,
        "revenue": {
          "currency": "USD",
          "value": 450
        },
        "revenueWithheld": false
      }
    ],
    "history": {
      "from": "2026-09-26T00:00:00.000Z",
      "to": "2026-10-03T00:00:00.000Z",
      "timezone": "UTC",
      "basis": "event_time",
      "series": [
        {
          "startsAt": "2026-10-01T00:00:00.000Z",
          "enrolled": 48,
          "completed": 30,
          "exited": 1
        },
        {
          "startsAt": "2026-10-02T00:00:00.000Z",
          "enrolled": 52,
          "completed": 41,
          "exited": 1
        }
      ]
    }
  }
}