Events

List event names

GET/v1/events/names

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

Event names to offer in triggers and goal pickers, each with its origin: system (recorded by Kirora), suggested (the standard e-commerce events, Segment v2 names, whether or not the workspace has sent them) or observed. The first page carries every preset name ahead of its limit observed ones; later pages carry observed names only, and only the first page has meta.nameUsage: the distinct names the workspace has tracked against its limit of 1,000; past it a new name is refused with EVENT_NAME_LIMIT_REACHED.

Query parameters

limitintegeroptional: min > 0 · max 100 · default 20
cursorstringoptional: 1–2048 characters

Returns

Returns 200 OK with a list of EventName objects in data, and the next page's cursor in meta (see pagination). Otherwise returns an error; Errors lists every code and which to retry.

namestringrequired
originstringrequired: one of system, suggested, observed
recordedbooleanrequired: Whether the workspace has tracked it; always true for an observed name.

curl https://api.kirora.io/v1/events/names \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/events/names', {
  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/events/names",
    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/events/names", 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": [
    {
      "name": "Weekend specials",
      "origin": "system",
      "recorded": true
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    },
    "nameUsage": {
      "count": 0,
      "limit": 1
    }
  }
}

Example values are generated from the schema.