DocumentationDeveloper PortalAPI EndpointsProduct Updates
API Endpoints
Contact Us

Get segment membership counts

get
https://api.getblueshift.com/api/v1/segments//matching_users.json

Use this endpoint to get count of users in the segment.

Path Params
string
required

UUID of the segment.

Query Params
boolean

Trigger job to update segment counts. Counts are updated asynchronously in the background. Use refresh=true to trigger a new count update, and subsequently poll with refresh=false to retrieve updated counts.

string

Channels can be one of: 'users', 'email', 'push', 'sms', or 'inApp'. Parameter indicates which channel audience counts to refresh.

boolean

Set 'true' to return counts bypassing the global inclusion segments.

Responses

400

Bad request - The request was invalid or cannot be otherwise served. An accompanying error message will explain further.

404

Resource not found - Can happen due to resource conflicts. Re-try with exponential backoff. Contact us on [email protected] if the issue persists.

409

Conflict error, please retry - The request could not be completed due to a conflict with the current state of the target resource, re-try with exponential backoff.

429

Rate limit exceeded - Too many requests. Contact us on [email protected] for recommended throughput.

500

Internal Server Error - Please contact blueshift for more information.

502

Service unavailable, please retry - Bad Gateway, re-try with exponential backoff.

503

Service unavailable, please retry - Service Unavailable, re-try with exponential backoff.

504

Service unavailable, please retry - Gateway Timeout, please re-try with exponential backoff.

Updated 2 days ago

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

Updated 2 days ago