Retrieve an event's summaryMenu

Retrieve an event's summary

GET/v1/events/summary

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

Works with integration, agent and partner keys. Also available to embed sessions.

Whether an event is arriving and what it looks like, before a segment or journey is built on it: when it last happened, how many happened in the last 30 days (counted up to 100,000, countExact: false past it), the property keys its latest 1,000 events carry with their types and up to five sample values, and what reads it. A custom name never tracked nor defined, or deleted, is a 404. For charts, read the series. An API key always gets the sample values. An embed session gets none unless minted with includeAttributeValues, and none for a key that is a masked attribute.

Query parameters

namestringrequired

The event name, exactly as it was tracked.

1–128 characters

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

namestringrequired

originstringrequired

one of system, standard, custom

descriptionstring | nullrequired

The workspace's description, else Kirora's meaning for a system or standard name.

lastSeenAtstring | nullrequired

When the latest event happened; null when none is held: a standard or system name never sent, or every event past retention.

date-time

last30Daysobjectrequired

Events that happened in the last 30 days.

2 child attributes

countintegerrequired: min 0
countExactbooleanrequired: False when counting stopped at 100,000: the event is busier.

sampleobjectrequired

What the latest events of this name look like.

2 child attributes

eventsintegerrequired

How many of the latest events were sampled, up to 1,000.

min 0

propertiesobject[]required

The keys the sampled events carry, most common first.

4 child attributes

keystringrequired

typesstring[]required

The value types seen. date is a string written as an ISO-8601 date or date and time, which segment date operators can read; a property whose values are mixed lists each type, such as date and string.

samples(string | number | boolean)[]required

Up to five distinct scalar values.

seenInintegerrequired

How many of the sampled events carry this key.

min 0

usedByobjectrequired

What reads this event, up to 50 of each: journeys (trigger, exit conditions, waits and rules in their steps), segments and campaign audiences (event rules), conversion goals, and active workspace goals (any event in the measure, including a cohort's rules).

6 child attributes

journeysobject[]required

3 child attributes

idstringrequired: uuid
namestringrequired
statusstringrequired: one of draft, active, paused, ended

segmentsobject[]required

2 child attributes

idstringrequired: uuid
namestringrequired

campaignsobject[]required

3 child attributes

idstringrequired: uuid
namestringrequired
statusstringrequired: one of draft, scheduled, sending, testing, sent, cancelled

conversionGoalsobject[]required

3 child attributes

idstringrequired: uuid
campaignIdstring | nullrequired: uuid
journeyIdstring | nullrequired: uuid

goalsobject[]required

Active workspace goals whose measure names the event.

2 child attributes

idstringrequired: uuid
namestringrequired

hasMorebooleanrequired

More use it than are listed: each list stops at 50.

curl 'https://api.kirora.io/v1/events/summary?name=Order%20Completed' \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/events/summary?name=Order%20Completed', {
  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/events/summary?name=Order%20Completed",
    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/events/summary?name=Order%20Completed", 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/events/summary?name=Order%20Completed");
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": {
    "name": "Order Completed",
    "origin": "standard",
    "description": "A contact paid for an order: order_id, total, currency, products[].",
    "lastSeenAt": "2026-10-01T09:30:00.000Z",
    "last30Days": {
      "count": 412,
      "countExact": true
    },
    "sample": {
      "events": 412,
      "properties": [
        {
          "key": "total",
          "types": [
            "number"
          ],
          "samples": [
            46.5,
            18.5
          ],
          "seenIn": 412
        },
        {
          "key": "currency",
          "types": [
            "string"
          ],
          "samples": [
            "USD",
            "EUR"
          ],
          "seenIn": 410
        },
        {
          "key": "deliver_by",
          "types": [
            "date"
          ],
          "samples": [
            "2026-10-03",
            "2026-10-05"
          ],
          "seenIn": 388
        }
      ]
    },
    "usedBy": {
      "journeys": [
        {
          "id": "0192f3a4-3d5e-7a7f-8c43-6b8c9d0e1f2a",
          "name": "Post-purchase thank you",
          "status": "active"
        }
      ],
      "segments": [
        {
          "id": "0192f3a3-2c4d-7f6e-9b32-5a7b8c9d0e1f",
          "name": "Repeat buyers"
        }
      ],
      "campaigns": [],
      "conversionGoals": [],
      "goals": [],
      "hasMore": false
    }
  }
}