BrazeEx.Api.ExportKPI (braze_ex v1.0.1)
API calls for all endpoints tagged ExportKPI
.
Link to this section Summary
Functions
Daily Active Users by Date
This endpoint allows you to retrieve a daily series of the total number of unique active users on each date.
Monthly Active Users for Last 30 Days
This endpoint allows you to retrieve a daily series of the total number of unique active users over a 30-day rolling window.
Daily New Users by Date
This endpoint allows you to retrieve a daily series of the total number of new users on each date.
KPIs for Daily App Uninstalls by Date
This endpoint allows you to retrieve a daily series of the total number of uninstalls on each date.
Link to this section Functions
kpi_dau_data_series_get(connection, opts \\ [])
@spec kpi_dau_data_series_get( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
daily-active-users-by-date
Daily Active Users by Date
This endpoint allows you to retrieve a daily series of the total number of unique active users on each date.
rate-limit
Rate limit
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
response
Response
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,
"dau" : (int)
},
...
]
}
Tip: For help with CSV and API exports, visit Export troubleshooting.
parameters
Parameters
connection
(BrazeEx.Connection): Connection to serveropts
(keyword): Optional parameters:authorization
(String.t)::length
(integer()): (Required) Integer Maximum number of days beforeending_at
to include in the returned series. Must be between 1 and 100 (inclusive).:ending_at
(String.t): (Optional) Datetime (ISO 8601 string) Date on which the data series should end. Defaults to time of the request.:app_id
(String.t): (Optional) String App API identifier retrieved from the Developer Console. if excluded, results for all apps in app group will be returned.
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
kpi_mau_data_series_get(connection, opts \\ [])
@spec kpi_mau_data_series_get( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
monthly-active-users-for-last-30-days
Monthly Active Users for Last 30 Days
This endpoint allows you to retrieve a daily series of the total number of unique active users over a 30-day rolling window.
rate-limit
Rate limit
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
response
Response
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,
"mau" : (int)
},
...
]
}
Tip: For help with CSV and API exports, visit Export troubleshooting.
parameters
Parameters
connection
(BrazeEx.Connection): Connection to serveropts
(keyword): Optional parameters:authorization
(String.t)::length
(integer()): (Required) Integer Maximum number of days beforeending_at
to include in the returned series. Must be between 1 and 100 (inclusive).:ending_at
(String.t): (Optional) Datetime (ISO 8601 string) Date on which the data series should end. Defaults to time of the request.:app_id
(String.t): (Optional) String App API identifier retrieved from the Developer Console. if excluded, results for all apps in app group will be returned.
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
kpi_new_users_data_series_get(connection, opts \\ [])
@spec kpi_new_users_data_series_get( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
daily-new-users-by-date
Daily New Users by Date
This endpoint allows you to retrieve a daily series of the total number of new users on each date.
rate-limit
Rate limit
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
response
Response
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 Export troubleshooting.
parameters
Parameters
connection
(BrazeEx.Connection): Connection to serveropts
(keyword): Optional parameters:authorization
(String.t)::length
(integer()): (Required) Integer Maximum number of days beforeending_at
to include in the returned series. Must be between 1 and 100 (inclusive).:ending_at
(String.t): (Optional) Datetime (ISO 8601 string) Date on which the data series should end. Defaults to time of the request.:app_id
(String.t): (Optional) String App API identifier retrieved from the Developer Console. if excluded, results for all apps in app group will be returned.
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
kpi_uninstalls_data_series_get(connection, opts \\ [])
@spec kpi_uninstalls_data_series_get( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
kpis-for-daily-app-uninstalls-by-date
KPIs for Daily App Uninstalls by Date
This endpoint allows you to retrieve a daily series of the total number of uninstalls on each date.
rate-limit
Rate limit
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
response
Response
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,
"uninstalls" : (int)
},
...
]
}
Tip: For help with CSV and API exports, visit Export troubleshooting.
parameters
Parameters
connection
(BrazeEx.Connection): Connection to serveropts
(keyword): Optional parameters:authorization
(String.t)::length
(integer()): (Required) Integer Maximum number of days beforeending_at
to include in the returned series. Must be between 1 and 100 (inclusive).:ending_at
(String.t): (Optional) Datetime (ISO 8601 string) Date on which the data series should end. Defaults to time of the request.:app_id
(String.t): (Optional) String App API identifier retrieved from the Developer Console. if excluded, results for all apps in app group will be returned.
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure