Events

Retrieve an event name

GET/v1/events/names/{name}

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

How often the event arrived in the last 30 days, when it was last seen (null when no event of that name is held, so the name has never arrived or every one has passed retention), and the property keys its most recent 1,000 events carry, with their types and up to five sample values. Feeds the property pickers in segment and journey rules. An embed session gets no sample values unless minted with includeAttributeValues.

Path parameters

namestringrequired: 1–128 characters

Returns

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

namestringrequired

countLast30Daysintegerrequired

Events in the last 30 days, counted up to 100,000.

min 0 · max 9007199254740991

lastSeenAtstring | nullrequired

When the latest event arrived.

date-time

propertiesobject[]required

Keys seen in the most recent 1,000 events, most common first.

4 child attributes

keystringrequired

typesstring[]required

The value types seen under this key.

samplesstring | number | boolean[]required

Up to five distinct scalar values.

seenInintegerrequired

How many of the sampled events carry this key.

min 0 · max 9007199254740991

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), and conversion goals.

4 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, sent, cancelled

conversionGoalsobject[]required

3 child attributes

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

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

const response = await fetch('https://api.kirora.io/v1/events/names/Weekend specials', {
  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/Weekend specials",
    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/Weekend specials", 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",
    "countLast30Days": 0,
    "lastSeenAt": "2030-03-14T09:30:00Z",
    "properties": [
      {
        "key": "key_example",
        "types": [
          "string"
        ],
        "samples": [
          "samples_example"
        ],
        "seenIn": 0
      }
    ],
    "usedBy": {
      "journeys": [
        {
          "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
          "name": "Weekend specials",
          "status": "draft"
        }
      ],
      "segments": [
        {
          "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
          "name": "Weekend specials"
        }
      ],
      "campaigns": [
        {
          "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
          "name": "Weekend specials",
          "status": "draft"
        }
      ],
      "conversionGoals": [
        {
          "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
          "campaignId": "018f2a4e-6b1c-7d3e-9f40-3478765e5a6b",
          "journeyId": "018f2a4e-6b1c-7d3e-9f40-7cf2bf7e5a6b"
        }
      ]
    }
  }
}

Example values are generated from the schema.