Segments
Create a segment
Create a segment from a filter expression. It starts empty until evaluated. Validate and preview the filter first.
POST
/
api
/
v1
/
segments
Create a segment
curl --request POST \
--url https://www.useboom.ai/api/v1/segments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"filterExpression": {
"kind": "<string>",
"predicates": [
{
"kind": "<string>",
"customObjectType": "<string>",
"attributeFilters": [
{
"attr": "<string>",
"path": [
"<string>"
],
"value": "<string>"
}
],
"path": [
{
"customObjectType": "<string>",
"attributeFilters": [
{
"attr": "<string>",
"path": [
"<string>"
],
"value": "<string>"
}
],
"relationshipType": "<string>"
}
]
}
]
},
"description": "<string>",
"evaluationCadence": "REACTIVE_ONLY",
"dailyEvaluationHour": 11,
"skipWeekendEvaluation": true,
"outputColumns": {
"person": {
"columns": [],
"attributes": [
"<string>"
]
},
"customObjects": [
{
"typeName": "<string>",
"attributes": [
"<string>"
]
}
],
"computed": [
"<string>"
]
}
}
'import requests
url = "https://www.useboom.ai/api/v1/segments"
payload = {
"name": "<string>",
"slug": "<string>",
"filterExpression": {
"kind": "<string>",
"predicates": [
{
"kind": "<string>",
"customObjectType": "<string>",
"attributeFilters": [
{
"attr": "<string>",
"path": ["<string>"],
"value": "<string>"
}
],
"path": [
{
"customObjectType": "<string>",
"attributeFilters": [
{
"attr": "<string>",
"path": ["<string>"],
"value": "<string>"
}
],
"relationshipType": "<string>"
}
]
}
]
},
"description": "<string>",
"evaluationCadence": "REACTIVE_ONLY",
"dailyEvaluationHour": 11,
"skipWeekendEvaluation": True,
"outputColumns": {
"person": {
"columns": [],
"attributes": ["<string>"]
},
"customObjects": [
{
"typeName": "<string>",
"attributes": ["<string>"]
}
],
"computed": ["<string>"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
filterExpression: {
kind: '<string>',
predicates: [
{
kind: '<string>',
customObjectType: '<string>',
attributeFilters: [{attr: '<string>', path: ['<string>'], value: '<string>'}],
path: [
{
customObjectType: '<string>',
attributeFilters: [{attr: '<string>', path: ['<string>'], value: '<string>'}],
relationshipType: '<string>'
}
]
}
]
},
description: '<string>',
evaluationCadence: 'REACTIVE_ONLY',
dailyEvaluationHour: 11,
skipWeekendEvaluation: true,
outputColumns: {
person: {columns: [], attributes: ['<string>']},
customObjects: [{typeName: '<string>', attributes: ['<string>']}],
computed: ['<string>']
}
})
};
fetch('https://www.useboom.ai/api/v1/segments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.useboom.ai/api/v1/segments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'filterExpression' => [
'kind' => '<string>',
'predicates' => [
[
'kind' => '<string>',
'customObjectType' => '<string>',
'attributeFilters' => [
[
'attr' => '<string>',
'path' => [
'<string>'
],
'value' => '<string>'
]
],
'path' => [
[
'customObjectType' => '<string>',
'attributeFilters' => [
[
'attr' => '<string>',
'path' => [
'<string>'
],
'value' => '<string>'
]
],
'relationshipType' => '<string>'
]
]
]
]
],
'description' => '<string>',
'evaluationCadence' => 'REACTIVE_ONLY',
'dailyEvaluationHour' => 11,
'skipWeekendEvaluation' => true,
'outputColumns' => [
'person' => [
'columns' => [
],
'attributes' => [
'<string>'
]
],
'customObjects' => [
[
'typeName' => '<string>',
'attributes' => [
'<string>'
]
]
],
'computed' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.useboom.ai/api/v1/segments"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"filterExpression\": {\n \"kind\": \"<string>\",\n \"predicates\": [\n {\n \"kind\": \"<string>\",\n \"customObjectType\": \"<string>\",\n \"attributeFilters\": [\n {\n \"attr\": \"<string>\",\n \"path\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"path\": [\n {\n \"customObjectType\": \"<string>\",\n \"attributeFilters\": [\n {\n \"attr\": \"<string>\",\n \"path\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"relationshipType\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"description\": \"<string>\",\n \"evaluationCadence\": \"REACTIVE_ONLY\",\n \"dailyEvaluationHour\": 11,\n \"skipWeekendEvaluation\": true,\n \"outputColumns\": {\n \"person\": {\n \"columns\": [],\n \"attributes\": [\n \"<string>\"\n ]\n },\n \"customObjects\": [\n {\n \"typeName\": \"<string>\",\n \"attributes\": [\n \"<string>\"\n ]\n }\n ],\n \"computed\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.useboom.ai/api/v1/segments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"filterExpression\": {\n \"kind\": \"<string>\",\n \"predicates\": [\n {\n \"kind\": \"<string>\",\n \"customObjectType\": \"<string>\",\n \"attributeFilters\": [\n {\n \"attr\": \"<string>\",\n \"path\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"path\": [\n {\n \"customObjectType\": \"<string>\",\n \"attributeFilters\": [\n {\n \"attr\": \"<string>\",\n \"path\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"relationshipType\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"description\": \"<string>\",\n \"evaluationCadence\": \"REACTIVE_ONLY\",\n \"dailyEvaluationHour\": 11,\n \"skipWeekendEvaluation\": true,\n \"outputColumns\": {\n \"person\": {\n \"columns\": [],\n \"attributes\": [\n \"<string>\"\n ]\n },\n \"customObjects\": [\n {\n \"typeName\": \"<string>\",\n \"attributes\": [\n \"<string>\"\n ]\n }\n ],\n \"computed\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/segments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"filterExpression\": {\n \"kind\": \"<string>\",\n \"predicates\": [\n {\n \"kind\": \"<string>\",\n \"customObjectType\": \"<string>\",\n \"attributeFilters\": [\n {\n \"attr\": \"<string>\",\n \"path\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"path\": [\n {\n \"customObjectType\": \"<string>\",\n \"attributeFilters\": [\n {\n \"attr\": \"<string>\",\n \"path\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"relationshipType\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"description\": \"<string>\",\n \"evaluationCadence\": \"REACTIVE_ONLY\",\n \"dailyEvaluationHour\": 11,\n \"skipWeekendEvaluation\": true,\n \"outputColumns\": {\n \"person\": {\n \"columns\": [],\n \"attributes\": [\n \"<string>\"\n ]\n },\n \"customObjects\": [\n {\n \"typeName\": \"<string>\",\n \"attributes\": [\n \"<string>\"\n ]\n }\n ],\n \"computed\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"memberCount": 0,
"lastEvaluatedAt": "<string>",
"createdAt": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Organization API key, sent as Authorization: Bearer boom_org_....
Body
application/json
Display name.
Required string length:
1 - 120Permanent identifier, lowercase-kebab-case, unique in your organization. Cannot be changed after creation.
Required string length:
1 - 64Pattern:
^[a-z0-9]+(-[a-z0-9]+)*$The audience filter: a tree of predicates over person attributes, related data, and events. Discover valid attr tokens and operators with segments_catalog (GET /api/v1/segments/catalog).
Show child attributes
Show child attributes
Maximum string length:
1024How often the segment re-evaluates. Defaults to REACTIVE_ONLY — evaluate on demand with segments_evaluate.
Available options:
REACTIVE_ONLY, HOURLY, DAILY For DAILY cadence: the hour (0-23, in your organization timezone) the segment evaluates.
Required range:
0 <= x <= 23When true, the segment is not evaluated on weekends.
Optional extra columns to project for each member when the segment feeds downstream automations.
Show child attributes
Show child attributes
Response
Success
Unique identifier within your organization.
How often the segment is re-evaluated. REACTIVE_ONLY segments only change when evaluated explicitly.
Available options:
REACTIVE_ONLY, HOURLY, DAILY Live count of currently active members.
Required range:
-9007199254740991 <= x <= 9007199254740991ISO 8601 timestamp; null if the segment has never evaluated.
ISO 8601 timestamp.
Was this page helpful?
⌘I
Create a segment
curl --request POST \
--url https://www.useboom.ai/api/v1/segments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"filterExpression": {
"kind": "<string>",
"predicates": [
{
"kind": "<string>",
"customObjectType": "<string>",
"attributeFilters": [
{
"attr": "<string>",
"path": [
"<string>"
],
"value": "<string>"
}
],
"path": [
{
"customObjectType": "<string>",
"attributeFilters": [
{
"attr": "<string>",
"path": [
"<string>"
],
"value": "<string>"
}
],
"relationshipType": "<string>"
}
]
}
]
},
"description": "<string>",
"evaluationCadence": "REACTIVE_ONLY",
"dailyEvaluationHour": 11,
"skipWeekendEvaluation": true,
"outputColumns": {
"person": {
"columns": [],
"attributes": [
"<string>"
]
},
"customObjects": [
{
"typeName": "<string>",
"attributes": [
"<string>"
]
}
],
"computed": [
"<string>"
]
}
}
'import requests
url = "https://www.useboom.ai/api/v1/segments"
payload = {
"name": "<string>",
"slug": "<string>",
"filterExpression": {
"kind": "<string>",
"predicates": [
{
"kind": "<string>",
"customObjectType": "<string>",
"attributeFilters": [
{
"attr": "<string>",
"path": ["<string>"],
"value": "<string>"
}
],
"path": [
{
"customObjectType": "<string>",
"attributeFilters": [
{
"attr": "<string>",
"path": ["<string>"],
"value": "<string>"
}
],
"relationshipType": "<string>"
}
]
}
]
},
"description": "<string>",
"evaluationCadence": "REACTIVE_ONLY",
"dailyEvaluationHour": 11,
"skipWeekendEvaluation": True,
"outputColumns": {
"person": {
"columns": [],
"attributes": ["<string>"]
},
"customObjects": [
{
"typeName": "<string>",
"attributes": ["<string>"]
}
],
"computed": ["<string>"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
filterExpression: {
kind: '<string>',
predicates: [
{
kind: '<string>',
customObjectType: '<string>',
attributeFilters: [{attr: '<string>', path: ['<string>'], value: '<string>'}],
path: [
{
customObjectType: '<string>',
attributeFilters: [{attr: '<string>', path: ['<string>'], value: '<string>'}],
relationshipType: '<string>'
}
]
}
]
},
description: '<string>',
evaluationCadence: 'REACTIVE_ONLY',
dailyEvaluationHour: 11,
skipWeekendEvaluation: true,
outputColumns: {
person: {columns: [], attributes: ['<string>']},
customObjects: [{typeName: '<string>', attributes: ['<string>']}],
computed: ['<string>']
}
})
};
fetch('https://www.useboom.ai/api/v1/segments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.useboom.ai/api/v1/segments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'filterExpression' => [
'kind' => '<string>',
'predicates' => [
[
'kind' => '<string>',
'customObjectType' => '<string>',
'attributeFilters' => [
[
'attr' => '<string>',
'path' => [
'<string>'
],
'value' => '<string>'
]
],
'path' => [
[
'customObjectType' => '<string>',
'attributeFilters' => [
[
'attr' => '<string>',
'path' => [
'<string>'
],
'value' => '<string>'
]
],
'relationshipType' => '<string>'
]
]
]
]
],
'description' => '<string>',
'evaluationCadence' => 'REACTIVE_ONLY',
'dailyEvaluationHour' => 11,
'skipWeekendEvaluation' => true,
'outputColumns' => [
'person' => [
'columns' => [
],
'attributes' => [
'<string>'
]
],
'customObjects' => [
[
'typeName' => '<string>',
'attributes' => [
'<string>'
]
]
],
'computed' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.useboom.ai/api/v1/segments"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"filterExpression\": {\n \"kind\": \"<string>\",\n \"predicates\": [\n {\n \"kind\": \"<string>\",\n \"customObjectType\": \"<string>\",\n \"attributeFilters\": [\n {\n \"attr\": \"<string>\",\n \"path\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"path\": [\n {\n \"customObjectType\": \"<string>\",\n \"attributeFilters\": [\n {\n \"attr\": \"<string>\",\n \"path\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"relationshipType\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"description\": \"<string>\",\n \"evaluationCadence\": \"REACTIVE_ONLY\",\n \"dailyEvaluationHour\": 11,\n \"skipWeekendEvaluation\": true,\n \"outputColumns\": {\n \"person\": {\n \"columns\": [],\n \"attributes\": [\n \"<string>\"\n ]\n },\n \"customObjects\": [\n {\n \"typeName\": \"<string>\",\n \"attributes\": [\n \"<string>\"\n ]\n }\n ],\n \"computed\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.useboom.ai/api/v1/segments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"filterExpression\": {\n \"kind\": \"<string>\",\n \"predicates\": [\n {\n \"kind\": \"<string>\",\n \"customObjectType\": \"<string>\",\n \"attributeFilters\": [\n {\n \"attr\": \"<string>\",\n \"path\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"path\": [\n {\n \"customObjectType\": \"<string>\",\n \"attributeFilters\": [\n {\n \"attr\": \"<string>\",\n \"path\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"relationshipType\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"description\": \"<string>\",\n \"evaluationCadence\": \"REACTIVE_ONLY\",\n \"dailyEvaluationHour\": 11,\n \"skipWeekendEvaluation\": true,\n \"outputColumns\": {\n \"person\": {\n \"columns\": [],\n \"attributes\": [\n \"<string>\"\n ]\n },\n \"customObjects\": [\n {\n \"typeName\": \"<string>\",\n \"attributes\": [\n \"<string>\"\n ]\n }\n ],\n \"computed\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/segments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"filterExpression\": {\n \"kind\": \"<string>\",\n \"predicates\": [\n {\n \"kind\": \"<string>\",\n \"customObjectType\": \"<string>\",\n \"attributeFilters\": [\n {\n \"attr\": \"<string>\",\n \"path\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"path\": [\n {\n \"customObjectType\": \"<string>\",\n \"attributeFilters\": [\n {\n \"attr\": \"<string>\",\n \"path\": [\n \"<string>\"\n ],\n \"value\": \"<string>\"\n }\n ],\n \"relationshipType\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"description\": \"<string>\",\n \"evaluationCadence\": \"REACTIVE_ONLY\",\n \"dailyEvaluationHour\": 11,\n \"skipWeekendEvaluation\": true,\n \"outputColumns\": {\n \"person\": {\n \"columns\": [],\n \"attributes\": [\n \"<string>\"\n ]\n },\n \"customObjects\": [\n {\n \"typeName\": \"<string>\",\n \"attributes\": [\n \"<string>\"\n ]\n }\n ],\n \"computed\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"memberCount": 0,
"lastEvaluatedAt": "<string>",
"createdAt": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}