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.
important:
Looking for the api_key parameter?
As of May 2020, Braze has changed how we read API keys to be more secure. Now API keys must be passed as a request header, please see YOUR_REST_API_KEY within the Example Request below.
Braze will continue to support the api_key being passed through the request body and URL parameters, but will eventually be sunset. Please update your API calls accordingly.
Request Parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
segment_id |
Yes | String | Segment API Identifier |
Request Components
- Segment Identifier
Thesegment_idfor a given segment can be found in your Developer Console within your Braze account or you can use the Segment List Endpoint.
Example URL
https://rest.iad-01.braze.com/segments/details?segment_id=3bbc4555-8fa0-4c9b-a5c0-4505edf3e064
Example Request
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/segments/details?segment_id=3bbc4555-8fa0-4c9b-a5c0-4505edf3e064' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'
Response
1
2
3
4
5
6
7
8
9
10
11
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"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,
"text_description" : (string) segment description,
"tags" : (array) tag names associated with the segment
}
tip:
For help with CSV and API exports, visit our troubleshooting article here.
Edit this page on GitHub