このページはAIにより自動翻訳されており、不正確な内容が含まれている可能性があります。翻訳の誤りを報告するには、 GitHubでイシューを作成してください.
カスタムイベント分析をエクスポートする
get
/events/data_series
このエンドポイントを使用して、指定された期間にわたり、アプリ内でカスタムイベントが発生した回数の系列を取得します。
前提条件
このエンドポイントを使用するには、events.data_series 権限を持つ API キーが必要です。
レート制限
APIレート制限に記載されているように、このエンドポイントにはデフォルトのBrazeレート制限(1時間あたり250,000リクエスト)が適用されます。
リクエストパラメーター
| パラメーター | 必須 | データタイプ | 説明 |
|---|---|---|---|
event |
必須 | 文字列 | 分析を返すカスタムイベントの名前。 |
length |
必須 | 整数 | 返される系列に含める ending_at より前の最大単位数(日または時間)。1以上100以下でなければなりません。 |
unit |
オプション | 文字列 | データポイント間の時間の単位。day または hour を指定でき、デフォルトは day です。 |
ending_at |
オプション | 日時 (ISO-8601 文字列) |
データ系列が終了する日付。デフォルトはリクエストの時刻です。 |
app_id |
オプション | 文字列 | 特定のアプリに分析を限定するために、API Keys ページから取得したアプリ API 識別子。 |
segment_id |
オプション | 文字列 | セグメント API 識別子を参照してください。イベント分析を返す対象となる、分析が有効なSegmentを示すSegment 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
{
"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
},
...
]
}
致命的なエラーの応答コード
リクエストが致命的なエラーに遭遇した場合に返されるステータスコードと関連するエラーメッセージについては、致命的なエラーと応答を参照してください。
New Stuff!