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

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

前提条件

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

レート制限

For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the /purchases/product_list endpoint, as documented in API rate limits.

要求パラメータ

リクエスト例

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

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

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