アプリのセッションを時間ごとにエクスポートする
get
/sessions/data_series
このエンドポイントを使用して、指定された期間にわたり、アプリの一連のセッション数を取得します。
前提条件
このエンドポイントを使用するには、sessions.data_series
権限を持つ API キーが必要です。
レート制限
API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。
リクエストパラメーター
パラメーター | required | データ型 | 説明 |
---|---|---|---|
length |
required | 整数 | 返されるシリーズに ending_at が含まれるまでの最大単位数 (日または時間)。1以上100以下でなければなりません。 |
unit |
オプション | string | データポイント間の時間の単位。day または hour にすることができ、デフォルトは day です。 |
ending_at |
オプション | 日時 (ISO-8601文字列) |
データシリーズが終了する日付。デフォルトはリクエストの時刻です。 |
app_id |
オプション | string | 特定のアプリに分析を限定するために、API Keysページから取得したアプリAPI識別子。 |
segment_id |
オプション | string | 「セグメント API 識別子」を参照してください。セッションが返されるべき、分析可能なセグメントを示すセグメント ID。 |
リクエスト例
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/sessions/data_series?length=14&unit=day&ending_at=2018-06-28T23:59:59-5:00&app_id={{app_identifier}}&segment_id={{segment_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) point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
"sessions" : (int)
},
...
]
}
tip:
CSV および API のエクスポートに関するヘルプについては、「エクスポートのトラブルシューティング」を参照してください。
New Stuff!