Journeys

Retrieve journey statistics

GET/v1/journeys/{id}/stats

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

Entry, completion and exit counters for one journey.

Path parameters

idstringrequired: uuid

Query parameters

startDatestringoptional

First day, inclusive, in the workspace timezone. Give with endDate.

date

endDatestringoptional

Last day, inclusive, no later than today. Give with startDate; a window is at most 366 days. Omit both for the last 30 days.

date

Returns

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

enrolledintegerrequired

Runs started.

min 0 · max 9007199254740991

activeintegerrequired

Runs in progress now.

min 0 · max 9007199254740991

completedintegerrequired

Runs that reached the end.

min 0 · max 9007199254740991

exitedintegerrequired

Runs ended early, by exit event or by hand.

min 0 · max 9007199254740991

historyobjectrequired

Counts per day over the report window.

7 child attributes

startDatestringrequired

First day of the window, inclusive.

date

endDatestringrequired

Last day of the window, inclusive.

date

timezonestringrequired

The workspace timezone the days are in.

basis"event_time"required

Days are counted by when each event happened.

startstringrequired

The window start as an instant.

date-time

endstringrequired

The window end as an instant.

date-time

seriesobject[]required

One entry per day in the window.

4 child attributes

datestringrequired

The day, in timezone.

date

enrolledintegerrequired

Runs started that day.

min 0 · max 9007199254740991

completedintegerrequired

Runs that reached the end that day.

min 0 · max 9007199254740991

exitedintegerrequired

Runs ended early that day.

min 0 · max 9007199254740991

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

const response = await fetch('https://api.kirora.io/v1/journeys/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/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/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/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": {
    "enrolled": 0,
    "active": 0,
    "completed": 0,
    "exited": 0,
    "history": {
      "startDate": "2030-03-14",
      "endDate": "2030-03-14",
      "timezone": "Europe/London",
      "basis": "event_time",
      "start": "2030-03-14T09:30:00Z",
      "end": "2030-03-14T09:30:00Z",
      "series": [
        {
          "date": "2030-03-14",
          "enrolled": 0,
          "completed": 0,
          "exited": 0
        }
      ]
    }
  }
}

Example values are generated from the schema.