Preview Segment

Preview segment

curl --request POST \
  --url https://dev.tryunleashx.com/api/v1/global/segment/preview \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "audience_id": 123,
  "conditions": [
    {
      "field": "<string>",
      "value": "<string>"
    }
  ],
  "sample_limit": 123
}
'

import requests

url = "https://dev.tryunleashx.com/api/v1/global/segment/preview"

payload = {
    "audience_id": 123,
    "conditions": [
        {
            "field": "<string>",
            "value": "<string>"
        }
    ],
    "sample_limit": 123
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    audience_id: 123,
    conditions: [{field: '<string>', value: '<string>'}],
    sample_limit: 123
  })
};

fetch('https://dev.tryunleashx.com/api/v1/global/segment/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://dev.tryunleashx.com/api/v1/global/segment/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([
    'audience_id' => 123,
    'conditions' => [
        [
                'field' => '<string>',
                'value' => '<string>'
        ]
    ],
    'sample_limit' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://dev.tryunleashx.com/api/v1/global/segment/preview"

	payload := strings.NewReader("{\n  \"audience_id\": 123,\n  \"conditions\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sample_limit\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("token", "<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://dev.tryunleashx.com/api/v1/global/segment/preview")
  .header("token", "<token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"audience_id\": 123,\n  \"conditions\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sample_limit\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.tryunleashx.com/api/v1/global/segment/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["token"] = '<token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"audience_id\": 123,\n  \"conditions\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sample_limit\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "size": 123,
  "baselist_size": 123,
  "percentage": 123,
  "sample": [
    {
      "id": 123,
      "mobile_no": "<string>",
      "input_field": {}
    }
  ]
}

POST

segment

preview

Preview segment

curl --request POST \
  --url https://dev.tryunleashx.com/api/v1/global/segment/preview \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "audience_id": 123,
  "conditions": [
    {
      "field": "<string>",
      "value": "<string>"
    }
  ],
  "sample_limit": 123
}
'

import requests

url = "https://dev.tryunleashx.com/api/v1/global/segment/preview"

payload = {
    "audience_id": 123,
    "conditions": [
        {
            "field": "<string>",
            "value": "<string>"
        }
    ],
    "sample_limit": 123
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    audience_id: 123,
    conditions: [{field: '<string>', value: '<string>'}],
    sample_limit: 123
  })
};

fetch('https://dev.tryunleashx.com/api/v1/global/segment/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://dev.tryunleashx.com/api/v1/global/segment/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([
    'audience_id' => 123,
    'conditions' => [
        [
                'field' => '<string>',
                'value' => '<string>'
        ]
    ],
    'sample_limit' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://dev.tryunleashx.com/api/v1/global/segment/preview"

	payload := strings.NewReader("{\n  \"audience_id\": 123,\n  \"conditions\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sample_limit\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("token", "<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://dev.tryunleashx.com/api/v1/global/segment/preview")
  .header("token", "<token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"audience_id\": 123,\n  \"conditions\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sample_limit\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.tryunleashx.com/api/v1/global/segment/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["token"] = '<token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"audience_id\": 123,\n  \"conditions\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"sample_limit\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "size": 123,
  "baselist_size": 123,
  "percentage": 123,
  "sample": [
    {
      "id": 123,
      "mobile_no": "<string>",
      "input_field": {}
    }
  ]
}

Use this endpoint to test filter conditions against an audience’s contacts without saving a segment — powers the “Preview Contacts” step of the Create Segment modal.

Endpoint

POST /segment/preview Content-Type: application/json Authentication: Required (workspace auth)

Request Body

{
  "audience_id": 12,
  "match_type": "all",
  "conditions": [
    { "field": "plan", "operator": "is", "value": "premium" },
    { "field": "city", "operator": "contains", "value": "Mumbai" }
  ],
  "sample_limit": 20
}

Field	Type	Required	Description
`audience_id`	number	Yes	Audience to preview against. Must belong to the caller’s company/workspace.
`conditions` (alias `filter_conditions`)	array	No	Filter conditions, each `{ field, operator, value }` (flat format — see below). Omitted/empty → matches every contact of the audience.
`match_type`	string	No	`all` (AND across conditions, default) or `any` (OR across conditions).
`sample_limit`	number	No	Max number of sample contacts to return (default `20`).

Filter Condition Operators

operator must be one of:

Operator	Meaning
`is`	Equals (case-insensitive)
`is_not`	Not equals
`contains`	Substring match
`not_contains`	Substring does not match
`starts_with`	Field starts with value
`ends_with`	Field ends with value
`is_empty`	Field is empty
`is_not_empty`	Field is not empty
`in`	Field is one of a comma-separated list of values
`not_in`	Field is not one of a comma-separated list of values
`gt`	Numeric greater-than
`lt`	Numeric less-than

This flat { field, operator, value } format is different from the CONDITIONLIST tree accepted by Create Segment’s filter_conditions. Passing a CONDITIONLIST payload here will not be understood — it is read as { conditions: [...] } and, having no conditions array of its own, is treated as an empty filter (matches everything).

Response

{
  "size": 128,
  "baselist_size": 500,
  "percentage": 25.6,
  "sample": [
    {
      "id": 1001,
      "mobile_no": "+12025550123",
      "input_field": { "plan": "premium", "city": "Mumbai" }
    }
  ]
}

Field	Description
`size`	Number of contacts matching the filter
`baselist_size`	Total active contacts in the audience
`percentage`	`size / baselist_size * 100`, rounded to 2 decimals (`0` when the audience is empty)
`sample`	Up to `sample_limit` matching contacts, each with `id`, `mobile_no`, and `input_field` (its raw input data)

Behavior

Nothing is persisted — this endpoint only evaluates the filter.
Only active (non-soft-deleted) audience contacts are considered.
mobile_no in the sample is masked when the workspace’s company has phone number masking enabled.

Error Cases

Error	Cause
`Audience Id is required`	`audience_id` missing
`Audience not found`	`audience_id` doesn’t belong to the caller’s company/workspace, or is deleted

Example cURL

curl -X POST https://www.tryunleashx.com/api/v1/global/segment/preview \
  -H "Content-Type: application/json" \
  -H "token: <api_key>" \
  -d '{
    "audience_id": 12,
    "match_type": "all",
    "conditions": [
      { "field": "plan", "operator": "is", "value": "premium" }
    ]
  }'

Headers

token

string

required

API token for authentication

Body

application/json

audience_id

integer

required

Audience to preview against.

conditions

object[]

Flat filter conditions. Alias: filter_conditions. Omitted/empty matches every contact of the audience.

Show child attributes

match_type

enum<string>

all = AND across conditions (default), any = OR across conditions.

Available options:

all,

any

sample_limit

integer

Max number of sample contacts to return (default 20).

Response

Preview computed successfully

size

integer

Number of contacts matching the filter

baselist_size

integer

Total active contacts in the audience

percentage

number

size / baselist_size * 100, rounded to 2 decimals

sample

object[]

Show child attributes

API Documentation

Phone Numbers

Voice AI

Click to Call

Call Logs

Campaigns

Audience

Segment

Input Variables

Workspaces

Users

Endpoint

Request Body

Filter Condition Operators

Response

Behavior

Error Cases

Example cURL

Headers

Body

Response

​Endpoint

​Request Body

​Filter Condition Operators

​Response

​Behavior

​Error Cases

​Example cURL

Headers

Body

Response

Endpoint

Request Body

Filter Condition Operators

Response

Behavior

Error Cases

Example cURL