Exportar eventos personalizados

Use esse endpoint para exportar uma lista de eventos personalizados registrados para o seu aplicativo. Os eventos são retornados em grupos de 50, classificados em ordem alfabética.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão events.get.

Limite de taxa

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.

Parâmetros de consulta

Observe que cada chamada a esse endpoint retornará 50 eventos. Para mais de 50 eventos, use o cabeçalho Link para recuperar os dados na próxima página, conforme mostrado no exemplo de resposta a seguir.

Exemplos de solicitações

Sem cursor

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'

Com cursor

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'

Resposta

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

Códigos de resposta a erros fatais

Para obter os códigos de status e as mensagens de erro associadas que serão retornadas se sua solicitação encontrar um erro fatal, consulte Erros fatais.