Retrieve a journey's metrics step by stepMenu

Retrieve a journey's metrics step by step

GET/v1/journeys/{id}/step-metrics

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

Works with integration, agent and partner keys.

Where people are and what each step did, by step id across every version of the journey, so a step keeps its counts when others are added or moved. It counts the enrollments that entered the journey in the window (all time by default), wherever they are now; GET /v1/journeys/{id}/metrics counts by when each thing happened instead. Send steps carry their messages (email or push) and conversions; a random split, each path and how it converted. 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

Count only the enrollments that entered from then, inclusive: a date-time, or a date meaning the start of that day in the workspace timezone. Give with to; omit both for all time.

tostringoptional

Count only the enrollments that entered before then, exclusive, in the same forms. To include a whole last day, pass the day after it. No later than the end of today; a window touches at most 366 days. Give with from.

includeRemovedStepsstringoptional

true: also the steps no longer in the journey that enrollments passed through, with removed: true.

one of true, false

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 JourneyStepMetrics in data. Otherwise returns an error; Errors lists every code and which to retry.

generatedAtstringrequired

When the counters were read.

date-time

fromstring | nullrequired

Start of the window whose entering enrollments count; null for all time.

date-time

tostring | nullrequired

End of that window, exclusive.

date-time

stepsobject[]required

The journey's steps in order, by id across every version of the journey, then any removed ones asked for.

15 child attributes

stepIdstringrequired

The step's id.

namestring | nullrequired

The step's name, if it has one.

typestringrequired

The step type.

one of wait, wait_until, digest, send, branch, filter, split, random_split, action

removedbooleanrequired

Whether the step is no longer in the journey (with includeRemovedSteps).

enteredintegerrequired

Enrollments that reached this step, counted once each.

min 0

passedintegerrequired

Enrollments that reached this step and went on from it.

min 0

currentlyHereintegerrequired

Enrollments on this step now.

min 0

waitingHereintegerrequired

Of currentlyHere, those waiting out a timer or a due send.

min 0

completedHereintegerrequired

Enrollments that finished the journey at this step.

min 0

exitedHereintegerrequired

Enrollments that were ended early while on this step.

min 0

nextStepsobject[]required

Where enrollments went on to from this step: a decision step's paths, each by the step it leads to.

2 child attributes

nextStepIdstringrequired

The id of the step they went on to.

countintegerrequired

Enrollments that went there, counted once each.

min 0

emailJourneyEmailCountsoptional

On an email send step: the messages it created.

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

pushJourneyPushCountsoptional

On a push send step: the messages it created.

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

conversionsJourneyConversions[]optional

On a send step: conversions credited to its messages, per conversion goal.

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.

randomSplitobjectoptional

On a random split step: each path and how it converted.

1 child attribute

pathsobject[]required

4 child attributes

percentintegerrequired

The path's share of enrollments, as set.

min 0

nextStepIdstring | nullrequired

The id of the step it leads to; null is the holdout.

countintegerrequired

Enrollments that took it.

min 0

conversionGoalsobject[]required

One entry per journey conversion goal; reached by an event it counts, sent or not.

3 child attributes

conversionGoalIdstringrequired

uuid

contactsintegerrequired

Of those enrollments' contacts, how many did an event the conversion goal counts within its window after the split.

min 0

ratenumber | nullrequired

contacts / count; null with no enrollments. Against the holdout, the lift.

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

const response = await fetch('https://api.kirora.io/v1/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/step-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/step-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/step-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/step-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": {
    "generatedAt": "2026-10-02T14:05:00.000Z",
    "from": null,
    "to": null,
    "steps": [
      {
        "stepId": "wait-an-hour",
        "name": "Wait an hour",
        "type": "wait",
        "removed": false,
        "entered": 128,
        "passed": 114,
        "currentlyHere": 12,
        "waitingHere": 12,
        "completedHere": 0,
        "exitedHere": 2,
        "nextSteps": [
          {
            "nextStepId": "welcome-email",
            "count": 114
          }
        ]
      },
      {
        "stepId": "welcome-email",
        "name": "Welcome email",
        "type": "send",
        "removed": false,
        "entered": 114,
        "passed": 0,
        "currentlyHere": 0,
        "waitingHere": 0,
        "completedHere": 114,
        "exitedHere": 0,
        "nextSteps": [],
        "email": {
          "created": 128,
          "queued": 0,
          "sending": 0,
          "failed": 1,
          "skipped": 3,
          "sent": 124,
          "delivered": 121,
          "bounced": 3,
          "complained": 0,
          "opened": 64,
          "openedByMachine": 18,
          "clicked": 19,
          "clickedByMachine": 2,
          "unsubscribed": 1,
          "simulated": 0
        },
        "conversions": [
          {
            "conversionGoal": {
              "id": "0192f3d0-7a1b-7c2d-8e3f-4a5b6c7d8e9f",
              "eventName": "Order Completed"
            },
            "count": 9,
            "revenue": {
              "currency": "USD",
              "value": 450
            },
            "revenueWithheld": false
          }
        ]
      }
    ]
  }
}