Exportar eventos personalizados

Utiliza este punto final para exportar una lista de eventos personalizados registrados para tu aplicación. Los eventos se devuelven en grupos de 50, ordenados alfabéticamente.

Requisitos previos

Para utilizar este punto final, necesitarás una clave de API con el permiso events.get.

Límite de velocidad

Para los clientes que se incorporaron a Braze a partir del 16 de septiembre de 2021, aplicamos un límite de velocidad compartido de 1000 solicitudes por hora a este punto final. Este límite de velocidad se comparte con los puntos finales /custom_attributes, /events/list, y /purchases/product_list, como se documenta en Límites de velocidad de la API.

Parámetros de consulta

Ten en cuenta que cada llamada a este punto final devolverá 50 eventos. Para más de 50 eventos, utiliza la cabecera Link para recuperar los datos en la página siguiente, como se muestra en el siguiente ejemplo de respuesta.

Ejemplos de solicitudes

Sin 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'

Con 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'

Respuesta

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 respuesta de error fatal

Para conocer los códigos de estado y los mensajes de error asociados que se devolverán si tu solicitud encuentra un error fatal, consulta Errores fatales.