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.

Parameters

Parameter Required Data Type Description
api_key Yes String App Group REST API Key.
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.

The segment_id for 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/data_series?api_key=75480f9a-4db8-4057-8b7e-4d59bfd73709&segment_id=3bbc4555-8fa0-4c9b-a5c0-4505edf3e064&length=7&ending_at=2014-12-10T23:59:59-05:00

Response

Content-Type: application/json

1
2
3
4
5
6
7
8
9
10
{
    "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!