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.
Parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
api_key |
Yes | String | App Group REST API Key. |
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. |
Example URL
https://rest.iad-01.braze.com/sessions/data_series?api_key=75480f9a-4db8-4057-8b7e-4d59bfd73709&length=24&unit=hour&ending_at=2014-12-10T23:59:59-05:00&app_id=3bbc4555-8fa0-4c9b-a5c0-4505edf3e064
Response
Content-Type: application/json
1
2
3
4
5
6
7
8
9
10
11
Content-Type: application/json
{
"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)
},
...
]
}
Edit this page on GitHub