Segments

Preview segment rules

POST/v1/segments/preview

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

Evaluates a rule tree that has not been saved and returns who it would match. Use this to check a segment definition before creating it.

Request body

rulesobjectrequired

The unsaved rule tree to evaluate.

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

countintegerrequired

Contacts the rules match, counted up to 10000.

min 0 · max 9007199254740991

countExactbooleanrequired

False when count is the cap and more contacts match.

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

const response = await fetch('https://api.kirora.io/v1/segments/preview', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "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/preview",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
    json={
        "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(`{
	  "rules": {
	    "all": [
	      {
	        "type": "attribute",
	        "field": "field_example",
	        "operator": "equals"
	      }
	    ]
	  }
	}`)
	req, err := http.NewRequest("POST", "https://api.kirora.io/v1/segments/preview", 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 · 200

{
  "data": {
    "count": 0,
    "countExact": true
  }
}

Example values are generated from the schema.