Exporter des événements personnalisés

Utilisez cet endpoint pour exporter une liste d’événements personnalisés enregistrés pour votre appli. Les événements sont renvoyés par groupes de 50, triés par ordre alphabétique.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation events.get.

Limite de débit

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.

Paramètres de recherche

Notez que chaque appel à cet endpoint renverra 50 événements. Pour plus de 50 événements, utilisez l’en-tête Link pour récupérer les données sur la page suivante, comme le montre l’exemple de réponse suivant.

Exemple de requêtes

Sans curseur

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'

Avec curseur

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'

Réponse

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

Codes de réponse des erreurs fatales

Pour connaître les codes d’état et les messages d’erreur associés qui seront renvoyés si votre requête rencontre une erreur fatale, reportez-vous à la section Erreurs fatales.