Session Analytics Endpoint

get

/sessions/data_series

This endpoint allows you to retrieve a series of the number of sessions for your app over a designated time period.

Request Parameters

Parameter Required Data Type Description
length Yes Integer Max number of units (days or hours) before ending_at to include in the returned series - must be between 1 and 100 inclusive.
unit No String Unit of time between data points - can be “day” or “hour” (defaults to “day”).
ending_at No DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request.
app_id No String App API Identifier retrieved from the Developer Console to limit analytics to a specific app.
segment_id No String Segment API Identifier indicating the analytics enabled segment for which sessions should be returned.

Request Components

Example URL

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

Example Request

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/sessions/data_series?length=14&unit=day&ending_at=2018-06-28T23:59:59-5:00&app_id=3bbc4555-8fa0-4c9b-a5c0-4505edf3e064&segment_id=12345678901234' \
--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) point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
            "sessions" : (int)
        },
        ...
    ]
}
WAS THIS PAGE HELPFUL?
New Stuff!