カスタムイベント分析のエクスポート
get
/events/data_series
このエンドポイントを使用して、指定した期間にアプリ内で発生したカスタムイベントの数の連続を取得します。
前提条件
このエンドポイントを使用するには、events.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.
要求パラメータ
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
event |
Required | String | 分析を返すカスタムイベントの名前。 |
length |
Required | Integer | ending_at より前の最大単位数(日数または時間数) が返された系列に含まれます。1 ~100 (両端を含む) である必要があります。 |
unit |
オプション | 文字列 | データポイント間の時間の単位。day またはhour にすることができます。デフォルトはday です。 |
ending_at |
オプション | 日時 (ISO-8601 string) |
データ系列が終了する日付。デフォルトは要求の時刻です。 |
app_id |
オプション | 文字列 | API Keys ページから取得されたアプリケーションAPI 識別子。分析を特定のアプリに制限します。 |
segment_id |
オプション | String | セグメントAPI 識別子 を参照してください。イベント分析を返す分析が有効なセグメントを示すセグメントID。 |
リクエスト例
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/events/data_series?event=event_name&length=24&unit=hour&ending_at=2014-12-10T23:59:59-05: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) the point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
"count" : (int) the number of occurrences of provided custom event
},
...
]
}
致命的なエラー応答コード
リクエストで致命的なエラーが発生した場合に返されるステータスコードと関連するエラーメッセージについては、Fatal errors & responses を参照してください。
tip:
CSV およびAPI エクスポートのヘルプについては、トラブルシューティング をエクスポートしてください。