Segments

Create a segment

POST/v1/segments

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

Segments are rule-based audiences, evaluated when they are used rather than stored as a fixed membership list. Names must be unique within the organization.

Request body

namestringrequired

Unique within the workspace.

1–255 characters

rulesobjectrequired

One of 2 shapes

Match all

1 child attribute

allobject[]required

Every rule or nested group must match.

at least 1 item · at most 20 items

Match any

1 child attribute

anyobject[]required

At least one rule or nested group must match.

at least 1 item · at most 20 items

Returns

Returns 201 Created with a Segment in data. Otherwise returns an error; Errors lists every code and which to retry.

idstringrequired

uuid

namestringrequired

rulesobjectrequired

One of 2 shapes

Match all

1 child attribute

allobject[]required

Every rule or nested group must match.

at least 1 item · at most 20 items

Match any

1 child attribute

anyobject[]required

At least one rule or nested group must match.

at least 1 item · at most 20 items

lastCountinteger | nullrequired

Audience size from the background count; null until first counted.

min 0 · max 9007199254740991

countedAtstring | nullrequired

When lastCount was taken.

date-time

createdAtstringrequired

date-time

updatedAtstringrequired

date-time

curl -X POST https://api.kirora.io/v1/segments \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekend specials",
    "rules": {
      "all": [
        {
          "type": "attribute",
          "field": "field_example",
          "operator": "equals"
        }
      ]
    }
  }'

const response = await fetch('https://api.kirora.io/v1/segments', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Weekend specials",
    "rules": {
      "all": [
        {
          "type": "attribute",
          "field": "field_example",
          "operator": "equals"
        }
      ]
    }
  }),
});
const { data } = await response.json();

import os

import requests

response = requests.post(
    "https://api.kirora.io/v1/segments",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
    json={
        "name": "Weekend specials",
        "rules": {
            "all": [
                {
                    "type": "attribute",
                    "field": "field_example",
                    "operator": "equals",
                },
            ],
        },
    },
)
data = response.json()["data"]

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "name": "Weekend specials",
	  "rules": {
	    "all": [
	      {
	        "type": "attribute",
	        "field": "field_example",
	        "operator": "equals"
	      }
	    ]
	  }
	}`)
	req, err := http.NewRequest("POST", "https://api.kirora.io/v1/segments", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	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 · 201

{
  "data": {
    "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
    "name": "Weekend specials",
    "rules": {
      "all": [
        {
          "type": "attribute",
          "field": "field_example",
          "operator": "equals"
        }
      ]
    },
    "lastCount": 0,
    "countedAt": "2030-03-14T09:30:00Z",
    "createdAt": "2030-03-14T09:30:00Z",
    "updatedAt": "2030-03-14T09:30:00Z"
  }
}

Example values are generated from the schema.