アプリのセッションを時間ごとにエクスポート
get
/sessions/data_series
このエンドポイントを使用して、指定した期間におけるアプリの一連のセッション数を取得します。
前提条件
このエンドポイントを使用するには、sessions.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の間でなければならない。 |
|||
unit |オプション|文字列|データポイント間の時間の単位。day hour デフォルトはday 。 |
|||
ending_at |任意|日時 (ISO-8601文字列)|データシリーズが終了する日付。デフォルトはリクエスト時刻。 |
|||
app_id |任意|文字列|特定のアプリにアナリティクスを制限するためにAPIキーページから取得したアプリAPI識別子。 |
|||
segment_id |任意|文字列|セグメント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エクスポートに関するヘルプは、エクスポートのトラブルシューティングをご覧ください。