Segments
Segments are saved filters over an audience. Target them from POST /broadcasts with segmentId.
Create segment
POST
/v1/segments | Field | Type | Required | Description |
|---|---|---|---|
| name | string | Required | Segment name. |
| audienceId | string | Required | Parent audience. |
| filter | object | Required | Filter tree (AND/OR of property rules). |
Example filter
{
"name": "Active trial",
"audienceId": "aud_onboarding",
"filter": {
"op": "and",
"rules": [
{ "field": "properties.plan", "cmp": "eq", "value": "trial" },
{ "field": "unsubscribed", "cmp": "eq", "value": false }
]
}
}List, get, delete
GET
/v1/segments GET
/v1/segments/{id} DELETE
/v1/segments/{id}