Journeys

Retrieve per-step journey statistics

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

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

Counters broken down by step, showing where contacts are accumulating or dropping out, with the email and push messages each send step created.

Path parameters

idstringrequired: uuid

Query parameters

definitionIdstringoptional: A version of the steps, from the journey definitions list; defaults to the current one.

Returns

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

definitionIdstringrequired

The version of the steps these counters are for.

matchesCurrentStepsbooleanrequired

Whether that version is the journey's current steps.

checkedAtstringrequired

When the counters were read.

date-time

enrollmentCountintegerrequired

Runs that followed this version.

min 0 · max 9007199254740991

stepsobject[]required

at most 50 items

9 child attributes

stepIndexintegerrequired

Index of the step in steps.

min 0 · max 9007199254740991

typestringrequired

The step type.

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

scheduledintegerrequired

Runs waiting to act on this step.

min 0 · max 9007199254740991

activeintegerrequired

Runs on this step now.

min 0 · max 9007199254740991

completedHereintegerrequired

Runs that finished the journey at this step.

min 0 · max 9007199254740991

exitedHereintegerrequired

Runs that were ended early while on this step.

min 0 · max 9007199254740991

emailobjectrequired

Email messages this step created, by status; zero for other steps.

9 child attributes

createdintegerrequired: min 0 · max 9007199254740991
queuedintegerrequired: min 0 · max 9007199254740991
sendingintegerrequired: min 0 · max 9007199254740991
failedintegerrequired: min 0 · max 9007199254740991
skippedintegerrequired: min 0 · max 9007199254740991
sentintegerrequired: min 0 · max 9007199254740991
deliveredintegerrequired: min 0 · max 9007199254740991
openedintegerrequired: min 0 · max 9007199254740991
clickedintegerrequired: min 0 · max 9007199254740991

pushobjectrequired

Push messages this step created, by status. No delivered: push services report acceptance, not arrival.

8 child attributes

createdintegerrequired: min 0 · max 9007199254740991
queuedintegerrequired: min 0 · max 9007199254740991
sendingintegerrequired: min 0 · max 9007199254740991
failedintegerrequired: min 0 · max 9007199254740991
skippedintegerrequired: min 0 · max 9007199254740991
sentintegerrequired: min 0 · max 9007199254740991
openedintegerrequired: min 0 · max 9007199254740991
clickedintegerrequired: min 0 · max 9007199254740991

conversionsobject[]required

Conversions credited to this step's messages, per goal; empty for others.

3 child attributes

goalIdstringrequired

The conversion goal.

uuid

countintegerrequired

Conversions credited to this step.

min 0 · max 9007199254740991

valuenumber | nullrequired

The goal's value total, in its currency; null when it names no value.

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

const response = await fetch('https://api.kirora.io/v1/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/step-stats', {
  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/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/step-stats",
    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/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/step-stats", 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": {
    "definitionId": "definitionId_example",
    "matchesCurrentSteps": true,
    "checkedAt": "2030-03-14T09:30:00Z",
    "enrollmentCount": 0,
    "steps": [
      {
        "stepIndex": 0,
        "type": "wait",
        "scheduled": 0,
        "active": 0,
        "completedHere": 0,
        "exitedHere": 0,
        "email": {
          "created": 0,
          "queued": 0,
          "sending": 0,
          "failed": 0,
          "skipped": 0,
          "sent": 0,
          "delivered": 0,
          "opened": 0,
          "clicked": 0
        },
        "push": {
          "created": 0,
          "queued": 0,
          "sending": 0,
          "failed": 0,
          "skipped": 0,
          "sent": 0,
          "opened": 0,
          "clicked": 0
        },
        "conversions": [
          {
            "goalId": null,
            "count": null,
            "value": null
          }
        ]
      }
    ]
  }
}

Example values are generated from the schema.