日別の新規ユーザーの日次エクスポート
get
/kpi/new_users/data_series
このエンドポイントを使用して、各日付の新しいユーザーの総数の日次情報を取得します。
前提条件
このエンドポイントを使用するには、API キーとkpi.new_users.data_series
の権限が必要です。
レート制限
API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。
リクエストパラメーター
パラメーター | required | データ型 | 説明 |
---|---|---|---|
length |
必須 | 整数 | 返されるシリーズに ending_at が含まれるまでの最大日数。1以上100以下でなければなりません。 |
ending_at |
オプション | 日時 (ISO-8601 文字列) |
データシリーズが終了する日付。リクエストの時刻にデフォルト設定されます。 |
app_id |
オプション | 文字列 | API Keysページから取得したアプリAPI識別子。除外した場合、ワークスペース内のすべてのアプリの結果が返される。 |
例のリクエスト
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'
応答
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,
"new_users" : (int) the number of daily new users
},
...
]
}
tip:
CSV および API のエクスポートに関するヘルプについては、「エクスポートのトラブルシューティング」を参照してください。
New Stuff!