Segments

List what uses a segment

GET/v1/segments/{id}/usage

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

Campaigns whose audience is this segment or whose rules name it, journeys whose rules or steps name it, and other segments whose rules name it. While any is listed, deleting the segment is refused (409 IN_USE, with this usage in details).

Path parameters

idstringrequired: uuid

Returns

Returns 200 OK. Otherwise returns an error; Errors lists every code and which to retry.

campaignsobject[]required

2 child attributes

idstringrequired: uuid
namestringrequired

journeysobject[]required

2 child attributes

idstringrequired: uuid
namestringrequired

segmentsobject[]required

2 child attributes

idstringrequired: uuid
namestringrequired

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

const response = await fetch('https://api.kirora.io/v1/segments/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/usage', {
  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/segments/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/usage",
    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/segments/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/usage", 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": {
    "campaigns": [
      {
        "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
        "name": "Weekend specials"
      }
    ],
    "journeys": [
      {
        "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
        "name": "Weekend specials"
      }
    ],
    "segments": [
      {
        "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
        "name": "Weekend specials"
      }
    ]
  }
}

Example values are generated from the schema.