Segment Analytics Endpoint

get

/segments/data_series

This endpoint allows you to retrieve a daily series of the size of a segment over time for a segment.

Request Parameters

Parameter Required Data Type Description
segment_id Yes String Segment API Identifier.
length Yes Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive.
ending_at No DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request.

Request Components

Example URL

https://rest.iad-01.braze.com/segments/data_series?segment_id=3bbc4555-8fa0-4c9b-a5c0-4505edf3e064&length=14&ending_at=2018-06-27T23:59:59-5:00

Example Request

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/segments/data_series?segment_id=3bbc4555-8fa0-4c9b-a5c0-4505edf3e064&length=14&ending_at=2018-06-27T23:59:59-5:00' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Response

1
2
3
4
5
6
7
8
9
10
11
12
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "data" : [
        {
            "time" : (string) date as ISO 8601 date,
            "size" : (int) size of the segment on that date
        },
        ...
    ]
}
WAS THIS PAGE HELPFUL?
New Stuff!