Segment Details Endpoint

get

/segments/details

This endpoint allows you to retrieve relevant information on the segment, which can be identified by the segment_id.

Parameters

Parameter Required Data Type Description
api_key Yes String App Group REST API Key
segment_id Yes String Segment API Identifier

Example URL

https://rest.iad-01.braze.com/segments/details?api_key=75480f9a-4db8-4057-8b7e-4d59bfd73709&segment_id=3bbc4555-8fa0-4c9b-a5c0-4505edf3e064

Response

1
2
3
4
5
6
7
8
9
Content-Type: application/json
{
      "message": (required, string) the status of the export, returns 'success' when completed without errors,
      "created_at" : (string) date created as ISO 8601 date,
      "updated_at" : (string) date last updated as ISO 8601 date,
      "name" : (string) segment name,
      "description" : (string) human-readable description of filters,
      "tags" : (array) tag names associated with the segment
}
WAS THIS PAGE HELPFUL?
New Stuff!