ONonesignal

View segment

Retrieve details for a single segment by its ID, including subscriber count and optionally segment metadata and filters.

get/apps/{app_id}/segments/{segment_id}

Request

  • Base URL
    https://api.onesignal.com
  • URL
    https://api.onesignal.com/apps/{app_id}/segments/{segment_id}
  • Auth
    none required

Path parameters

app_idstring required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

segment_idstring required

The segment's unique identifier. In the dashboard, go to Audience > Segments, open the segment's options menu, and select Copy segment ID. You can also get it from the View segments API or the segment's URL in the dashboard.

Query parameters

include-segment-detailboolean

Set to true to include segment metadata and filters in the response.

Headers

Authorizationstring required

Your App API key with prefix Key . See Keys & IDs.

Response

200

subscriber_countinteger

The number of subscribers matching this segment.

Changes

No recorded changes to this operation across all 2 revisions of this API.