Skip to content

Exportar eventos personalizados

get

/events

Utiliza este endpoint 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 endpoint, necesitarás una clave de API con el permiso events.get.

Límite de velocidad

Aplicamos un límite de velocidad compartido de 1000 solicitudes por hora a este endpoint. Este límite de velocidad se comparte con los endpoints /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 endpoint devolverá 50 eventos. Para más de 50 eventos, utiliza el encabezado Link para recuperar los datos en la página siguiente, como se muestra en el siguiente ejemplo de respuesta.

Parámetro Obligatorio Tipo de datos Descripción
cursor Opcional Cadena Determina la paginación de los eventos personalizados.

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

{
    "message": (string) returns 'success' when the request completes 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.
New Stuff!