braze_ex v1.0.22

BrazeEx.Api.ExportKPI (braze_ex v1.0.22)

API calls for all endpoints tagged ExportKPI.

Link to this section Summary

Functions

kpi_dau_data_series_get(connection, opts \\ [])

Export Daily Active Users by Date

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

kpi_mau_data_series_get(connection, opts \\ [])

Export Monthly Active Users for Last 30 Days

Use this endpoint to retrieve a daily series of the total number of unique active users over a 30-day rolling window.

kpi_new_users_data_series_get(connection, opts \\ [])

Export Daily New Users by Date

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

kpi_uninstalls_data_series_get(connection, opts \\ [])

Export KPIs for Daily App Uninstalls by Date

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

Link to this section Functions

Link to this function

kpi_dau_data_series_get(connection, opts \\ [])

@spec kpi_dau_data_series_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

export-daily-active-users-by-date

 Export Daily Active Users by Date

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

Note: If you are using our older navigation, API Keys can be found at Developer Console > API Settings.

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

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) the date as ISO 8601 date,
          "dau" : (int) the number of daily active users
      },
      ...
  ]
}

Tip: For help with CSV and API exports, visit Export troubleshooting.

parameters

 Parameters

  • connection (BrazeEx.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :Authorization (String.t):
    • :length (integer()): (Required) Integer Maximum number of days before ending_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 API Keys page. If excluded, results for all apps in the workspace will be returned.

returns

 Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

kpi_mau_data_series_get(connection, opts \\ [])

@spec kpi_mau_data_series_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

export-monthly-active-users-for-last-30-days

 Export Monthly Active Users for Last 30 Days

Use this endpoint to retrieve a daily series of the total number of unique active users over a 30-day rolling window.

Note: If you are using our older navigation, API Keys can be found at Developer Console > API Settings.

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

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) the date as ISO 8601 date,
          "mau" : (int) the number of monthly active users
      },
      ...
  ]
}

Tip: For help with CSV and API exports, visit Export troubleshooting.

parameters

 Parameters

  • connection (BrazeEx.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :Authorization (String.t):
    • :length (integer()): (Required) Integer Maximum number of days before ending_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 API Keys page. If excluded, results for all apps in the workspace will be returned.

returns

 Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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()}

export-daily-new-users-by-date

 Export Daily New Users by Date

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

Note: If you are using our older navigation, app_id can be found at Developer Console > API Settings.

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

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) the date as ISO 8601 date,
          "new_users" : (int) the number of daily new users
      },
      ...
  ]
}

Tip: For help with CSV and API exports, visit Export troubleshooting.

parameters

 Parameters

  • connection (BrazeEx.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :Authorization (String.t):
    • :length (integer()): (Required) Integer Maximum number of days before ending_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 API Keys page. If excluded, results for all apps in the workspace will be returned.

returns

 Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

kpi_uninstalls_data_series_get(connection, opts \\ [])

@spec kpi_uninstalls_data_series_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

export-kpis-for-daily-app-uninstalls-by-date

 Export KPIs for Daily App Uninstalls by Date

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

Note: If you are using our older navigation, API Keys can be found at Developer Console > API Settings.

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

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) the date as ISO 8601 date,
          "uninstalls" : (int) the number of uninstalls
      },
      ...
  ]
}

Tip: For help with CSV and API exports, visit Export troubleshooting.

parameters

 Parameters

  • connection (BrazeEx.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :Authorization (String.t):
    • :length (integer()): (Required) Integer Maximum number of days before ending_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 API Keys page. If excluded, results for all apps in the workspace will be returned.

returns

 Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure