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.

Request Parameters

Parameter Required Data Type Description
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
app_id No String App API Identifier; if excluded, results for all apps in app group will be returned

Example URL

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

Example Request

1
2
curl --location --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)
        },
        ...
    ]
}
WAS THIS PAGE HELPFUL?
New Stuff!