Get the segment filter catalog
Everything filterable in your organization — person attributes, related data, computed variables, and the events people can be filtered on — with the token and operators to use for each. Read this first when building a filter. The events section is what makes behavioural filters possible: an event predicate matches on whether a person performed an event, optionally narrowed by its payload (propertyFilters) and when it happened (window).
curl --request GET \
--url https://www.useboom.ai/api/v1/segments/catalog \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.useboom.ai/api/v1/segments/catalog"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.useboom.ai/api/v1/segments/catalog', 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/catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.useboom.ai/api/v1/segments/catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.useboom.ai/api/v1/segments/catalog")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/segments/catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"personAttributes": [
{
"attr": "<string>",
"type": "STRING",
"operators": [
"<string>"
],
"description": "<string>"
}
],
"computedVariables": [
{
"attr": "<string>",
"type": "STRING",
"operators": [
"<string>"
],
"description": "<string>",
"label": "<string>",
"group": "<string>"
}
],
"customObjectTypes": [
{
"name": "<string>",
"displayName": "<string>",
"attributes": [
{
"attr": "<string>",
"type": "STRING",
"operators": [
"<string>"
],
"description": "<string>"
}
]
}
],
"reachableObjects": [
{
"typeName": "<string>",
"paths": [
[
{
"customObjectType": "<string>",
"attributeFilters": [
"<unknown>"
],
"direction": "parent_to_child",
"relationshipType": "<string>"
}
]
]
}
],
"events": [
{
"eventName": "<string>",
"description": "<string>",
"properties": [
{
"key": "<string>",
"type": "STRING",
"operators": [
"<string>"
],
"description": "<string>"
}
]
}
],
"eventWindowOperators": [
"<string>"
],
"operatorReference": [
{
"operator": "<string>",
"takesValue": true,
"valueShape": "none",
"description": "<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_....
Response
Success
Person columns and custom person attributes.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Events this org has recorded, filterable with an event predicate (kind: "event") on whether a person performed them.
Show child attributes
Show child attributes
Operators valid in an event predicate's window. Past-oriented only — the same list for every event.
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://www.useboom.ai/api/v1/segments/catalog \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.useboom.ai/api/v1/segments/catalog"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.useboom.ai/api/v1/segments/catalog', 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/catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.useboom.ai/api/v1/segments/catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.useboom.ai/api/v1/segments/catalog")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/segments/catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"personAttributes": [
{
"attr": "<string>",
"type": "STRING",
"operators": [
"<string>"
],
"description": "<string>"
}
],
"computedVariables": [
{
"attr": "<string>",
"type": "STRING",
"operators": [
"<string>"
],
"description": "<string>",
"label": "<string>",
"group": "<string>"
}
],
"customObjectTypes": [
{
"name": "<string>",
"displayName": "<string>",
"attributes": [
{
"attr": "<string>",
"type": "STRING",
"operators": [
"<string>"
],
"description": "<string>"
}
]
}
],
"reachableObjects": [
{
"typeName": "<string>",
"paths": [
[
{
"customObjectType": "<string>",
"attributeFilters": [
"<unknown>"
],
"direction": "parent_to_child",
"relationshipType": "<string>"
}
]
]
}
],
"events": [
{
"eventName": "<string>",
"description": "<string>",
"properties": [
{
"key": "<string>",
"type": "STRING",
"operators": [
"<string>"
],
"description": "<string>"
}
]
}
],
"eventWindowOperators": [
"<string>"
],
"operatorReference": [
{
"operator": "<string>",
"takesValue": true,
"valueShape": "none",
"description": "<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>"
}
}