Preview segment rules or bucket

Returns the total number of subscribers which match the given segment rules if rules provided in body. If instead segmentBucketId is provided, will get the count of the existing segment bucket. Do not provide both at same time

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
rules
array

Rules which will be used to filter subscribers to add to your segment. Full reference can be found on the Segment rules page

rules
boolean
Defaults to true

Exclude subscribers who have notifications disabled on their device. Though subscribers with notifications disabled will not receive them to their device, they will still get inapp notifications regardless of if they have notifications disabled on their device. Use this excludeUnsubscribers flag to test segment reach for different notification types

Responses

401

Id Token or X-API-Key/X-API-Secret is missing or invalid.

403

The server understood the request but refuses to authorize it. In most cases due to insufficient user permissions.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json