カスタムイベントリストのエクスポート

このエンドポイントを使用して、アプリに記録されたカスタムイベントのリストをエクスポートします。イベント名はアルファベット順にソートされ、250件ずつのグループで返されます。

前提条件

このエンドポイントを使用するには、events.list 権限を持つ APIキーが必要です。

レート制限

このエンドポイントには、1時間あたり1,000リクエストの共有レート制限が適用されます。このレート制限は、APIレート制限に記載されているように、/custom_attributes、/events、および /purchases/product_list エンドポイントと共有されます。

リクエストパラメーター

リクエスト例

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
{
    "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,
        ...
    ]
}

致命的なエラーの応答コード

リクエストで致命的なエラーが発生した場合に返されるステータスコードと関連するエラーメッセージについては、致命的なエラーと応答を参照してください。