カスタム・イベントのリストをエクスポートする
get
/events/list
アプリに記録されたカスタム・イベントのリストをエクスポートするには、このエンドポイントを使用する。イベント名はアルファベット順に並べられ、250のグループで返される。
前提条件
このエンドポイントを使用するには、events.list
権限を持つ API キーが必要です。
レート制限
リクエストパラメーター
パラメーター | required | データ型 | 説明 |
---|---|---|---|
page |
オプション | 整数 | 返されるイベント名のページ。デフォルトは0です (最大250の最初のセットを返す)。 |
リクエスト例
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/events/list?page=3' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
応答
1
2
3
4
5
6
7
8
9
10
11
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"message": (required, string) the status of the export, returns 'success' when completed without errors,
"events" : [
"Event A", (string) the event name,
"Event B", (string) the event name,
"Event C", (string) the event name,
...
]
}
致命的なエラーの応答コード
リクエストが致命的なエラーに遭遇した場合に返されるステータスコードと関連するエラーメッセージについては、致命的なエラーと応答を参照してください。
tip:
CSV および API のエクスポートに関するヘルプについては、「エクスポートのトラブルシューティング」を参照してください。
New Stuff!