Skip to content

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

get

/events

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

前提条件

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

レート制限

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 /custom_attributes, /events/list, and /purchases/product_list endpoints, as documented in API rate limits.

クエリパラメータ

このエンドポイントへの各呼び出しは50のイベントを返すことに注意してください。50を超えるイベントについては、次の応答の例に示すように、Link ヘッダーを使用して次のページのデータを取得します。

パラメータ required データ型 説明
cursor オプション string カスタムイベントのページネーションを決定します。

例のリクエスト

カーソルなし

1
2
3

curl --location --request GET 'https://rest.iad-01.braze.com/events' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

カーソル付き

1
2
3

curl --location --request GET 'https://rest.iad-03.braze.com/events?cursor=c2tpcDow' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

応答

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

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" : [
        {
            "name": "The event name", (string) the event name,
            "description": "The event description", (string) the event description,
            "included_in_analytics_report": false, (boolean) the analytics report inclusion,
            "status": "Active", (string) the event status,
            "tag_names": ["Tag One", "Tag Two"] (array) the tag names associated with the event formatted as strings,
        },
        ...
    ]
}

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

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

  GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!