Broadcasts
List every audience
All thirteen segments with labels, descriptions and current counts, so a UI can offer them without hard-coding the list. Segments that address a single window report recipient_estimate: null; they cannot be sized without a window id.
| Field | Type | Meaning |
|---|---|---|
| value | string | The segment key to send as audience. |
| label, description | string | The words the dashboard shows, in the creator's language. |
| requires_pass_window | boolean | Whether the segment needs a pass_window_id. |
| supports_plan_filter | boolean | Whether plan_id is accepted. False for lead and the pass segments. |
| requires_expiring_within_days | boolean | Whether the segment reads a horizon. True only for expiring_soon. |
| recipient_estimate | integer or null | Who the segment reaches right now; null where a window must be named first. |
get/v1/projects/{project}/broadcasts/audiences
Request
- Base URL: https://api.subscriby.net
- URL: https://api.subscriby.net/v1/projects/{project}/broadcasts/audiences
- Auth: HTTP bearer
Path parameters
projectstring uuid required
The project, resolved by the route binder.
Response
Every segment with its label, its rules and a recipient estimate where one can be given without a window.
Changes
No recorded changes to this operation across all 1 revision of this API.