Skip to content

Export KPIs for daily app uninstalls by date

get

/kpi/uninstalls/data_series

Use this endpoint to retrieve a daily series of the total number of uninstalls on each date.

Prerequisites

To use this endpoint, you’ll need an API key with the kpi.uninstalls.data_series permission.

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 Maximum 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 API Keys page. If excluded, results for all apps in workspace will be returned.

Example request

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/kpi/uninstalls/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) the date as ISO 8601 date,
            "uninstalls" : (int) the number of uninstalls
        },
        ...
    ]
}
HOW HELPFUL WAS THIS PAGE?
New Stuff!