日次新規ユーザーを日付別にエクスポート
get
/kpi/new_users/data_series
このエンドポイントを使用して、各日付の新規ユーザーの合計数の日次系列を取得します。
前提 条件
このエンドポイントを使用するには、アクセス許可を持つ kpi.new_users.data_series
API キーが必要です。
レート制限
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
要求パラメーター
パラメータ | 必須項目 | データ型 | 説明 |
---|---|---|---|
length |
必須項目 | 整数型 | 返される系列に含めるまでの ending_at 最大日数。1 以上 100 以下である必要があります。 |
ending_at |
オプション | 日時 (ISO-8601 文字列) |
データ系列が終了する日付。既定値は、要求の時刻です。 |
app_id |
オプション | 文字列 | [API キー ] ページから取得したアプリの 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 のエクスポートに関するヘルプについては、 エクスポートのトラブルシューティングをご覧ください。