Daily new users endpoint
get
/kpi/new_users/data_series
This endpoint allows you to retrieve a daily series of the total number of new users on each date.
Rate limit
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
Request parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
length |
Required | Integer | Max number of days before ending_at to include in the returned series. Must be between 1 and 100 (inclusive). |
ending_at |
Optional | Datetime (ISO-8601 string) |
Date on which the data series should end. Defaults to time of the request. |
app_id |
Optional | String | App API identifier retrieved from the Developer Console. If excluded, results for all apps in app group will be returned. |
Example request
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/kpi/new_users/data_series?length=14&ending_at=2018-06-28T23:59:59-5:00&app_id={{app_identifier}}' \
--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,
"new_users" : (int)
},
...
]
}
tip:
For help with CSV and API exports, visit our troubleshooting article here.
Edit this page on GitHub