Segments
Validate a segment filter
Dry-run a filter expression against your live catalog — nothing is saved. Returns whether it’s valid, or the field to fix.
POST
/
api
/
v1
/
segments
/
validate
Validate a segment filter
curl --request POST \
--url https://www.useboom.ai/api/v1/segments/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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>"
}
]
}
]
}
}
'import requests
url = "https://www.useboom.ai/api/v1/segments/validate"
payload = { "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>"
}
]
}
]
} }
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({
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>'
}
]
}
]
}
})
};
fetch('https://www.useboom.ai/api/v1/segments/validate', 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/validate",
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([
'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>'
]
]
]
]
]
]),
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/validate"
payload := strings.NewReader("{\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}")
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/validate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/segments/validate")
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 \"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}"
response = http.request(request)
puts response.read_body{
"valid": true
}{
"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
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
Response
Success
Always true when the filter is valid.
Was this page helpful?
⌘I
Validate a segment filter
curl --request POST \
--url https://www.useboom.ai/api/v1/segments/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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>"
}
]
}
]
}
}
'import requests
url = "https://www.useboom.ai/api/v1/segments/validate"
payload = { "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>"
}
]
}
]
} }
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({
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>'
}
]
}
]
}
})
};
fetch('https://www.useboom.ai/api/v1/segments/validate', 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/validate",
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([
'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>'
]
]
]
]
]
]),
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/validate"
payload := strings.NewReader("{\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}")
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/validate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/segments/validate")
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 \"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}"
response = http.request(request)
puts response.read_body{
"valid": true
}{
"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>"
}
}