Preview an unsaved segment filter
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/segments/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"op": "AND",
"conditions": [
{
"field": "lifecycle_stage",
"op": "equals",
"value": "customer"
},
{
"field": "country_code",
"op": "equals",
"value": "DE"
}
]
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/segments/preview"
payload = { "filters": {
"op": "AND",
"conditions": [
{
"field": "lifecycle_stage",
"op": "equals",
"value": "customer"
},
{
"field": "country_code",
"op": "equals",
"value": "DE"
}
]
} }
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({
filters: {
op: 'AND',
conditions: [
{field: 'lifecycle_stage', op: 'equals', value: 'customer'},
{field: 'country_code', op: 'equals', value: 'DE'}
]
}
})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/segments/preview', 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://api.orbit.devotel.io/api/v1/contacts/segments/preview",
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([
'filters' => [
'op' => 'AND',
'conditions' => [
[
'field' => 'lifecycle_stage',
'op' => 'equals',
'value' => 'customer'
],
[
'field' => 'country_code',
'op' => 'equals',
'value' => 'DE'
]
]
]
]),
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://api.orbit.devotel.io/api/v1/contacts/segments/preview"
payload := strings.NewReader("{\n \"filters\": {\n \"op\": \"AND\",\n \"conditions\": [\n {\n \"field\": \"lifecycle_stage\",\n \"op\": \"equals\",\n \"value\": \"customer\"\n },\n {\n \"field\": \"country_code\",\n \"op\": \"equals\",\n \"value\": \"DE\"\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://api.orbit.devotel.io/api/v1/contacts/segments/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"op\": \"AND\",\n \"conditions\": [\n {\n \"field\": \"lifecycle_stage\",\n \"op\": \"equals\",\n \"value\": \"customer\"\n },\n {\n \"field\": \"country_code\",\n \"op\": \"equals\",\n \"value\": \"DE\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/segments/preview")
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 \"filters\": {\n \"op\": \"AND\",\n \"conditions\": [\n {\n \"field\": \"lifecycle_stage\",\n \"op\": \"equals\",\n \"value\": \"customer\"\n },\n {\n \"field\": \"country_code\",\n \"op\": \"equals\",\n \"value\": \"DE\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"meta": {}
}Contacts
Preview an unsaved segment filter
Evaluate a filter AST WITHOUT persisting anything and return the exact matched count plus the first 10 matching contacts. Powers the live preview in the rule-builder UI as the operator edits conditions. For a fast, approximate size estimate on every keystroke use POST /segments/estimate instead; for the persisted count use POST /segments/:id/evaluate.
POST
/
api
/
v1
/
contacts
/
segments
/
preview
Preview an unsaved segment filter
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/segments/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"op": "AND",
"conditions": [
{
"field": "lifecycle_stage",
"op": "equals",
"value": "customer"
},
{
"field": "country_code",
"op": "equals",
"value": "DE"
}
]
}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/segments/preview"
payload = { "filters": {
"op": "AND",
"conditions": [
{
"field": "lifecycle_stage",
"op": "equals",
"value": "customer"
},
{
"field": "country_code",
"op": "equals",
"value": "DE"
}
]
} }
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({
filters: {
op: 'AND',
conditions: [
{field: 'lifecycle_stage', op: 'equals', value: 'customer'},
{field: 'country_code', op: 'equals', value: 'DE'}
]
}
})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/segments/preview', 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://api.orbit.devotel.io/api/v1/contacts/segments/preview",
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([
'filters' => [
'op' => 'AND',
'conditions' => [
[
'field' => 'lifecycle_stage',
'op' => 'equals',
'value' => 'customer'
],
[
'field' => 'country_code',
'op' => 'equals',
'value' => 'DE'
]
]
]
]),
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://api.orbit.devotel.io/api/v1/contacts/segments/preview"
payload := strings.NewReader("{\n \"filters\": {\n \"op\": \"AND\",\n \"conditions\": [\n {\n \"field\": \"lifecycle_stage\",\n \"op\": \"equals\",\n \"value\": \"customer\"\n },\n {\n \"field\": \"country_code\",\n \"op\": \"equals\",\n \"value\": \"DE\"\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://api.orbit.devotel.io/api/v1/contacts/segments/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"op\": \"AND\",\n \"conditions\": [\n {\n \"field\": \"lifecycle_stage\",\n \"op\": \"equals\",\n \"value\": \"customer\"\n },\n {\n \"field\": \"country_code\",\n \"op\": \"equals\",\n \"value\": \"DE\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/segments/preview")
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 \"filters\": {\n \"op\": \"AND\",\n \"conditions\": [\n {\n \"field\": \"lifecycle_stage\",\n \"op\": \"equals\",\n \"value\": \"customer\"\n },\n {\n \"field\": \"country_code\",\n \"op\": \"equals\",\n \"value\": \"DE\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"meta": {}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
The AND/OR filter AST to evaluate ({ op, conditions }).
⌘I