Exporter la liste des campagnes

get

/campaigns/list

Utilisez cet endpoint pour exporter une liste de campagnes, chacune incluant son nom, l’identifiant API de la campagne, s’il s’agit d’une campagne par API, et les balises associées à la campagne.

Les campagnes sont renvoyées par groupes de 100 triés par date de création (des plus anciens aux plus récents par défaut).

See me in Postman

Conditions préalables

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

Limite de débit

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

Paramètres de demande

Paramètre Requis Type de données Description

page Facultatif Entier La page des campagnes à renvoyer, par défaut sur 0 (renvoie le premier ensemble jusqu’à 100 éléments).

include_archived Facultatif Valeur booléenne S’il faut inclure ou non des campagnes archivées, par défaut sur Faux.

sort_direction Facultatif Chaîne de caractères - Trier l’heure de création de la plus récente à la plus ancienne : indiquer la valeur desc.
- Trier l’heure de création de la plus ancienne à la plus récente : indiquer la valeur asc.

Si sort_direction n’est pas inclus, l’ordre par défaut est de la plus ancienne à la plus récente.

last_edit.time[gt] Facultatif Date Filtre les résultats et renvoie uniquement les campagnes qui ont été modifiées au-delà de l’heure indiquée jusqu’à maintenant. Le format est yyyy-MM-DDTHH:mm:ss.

Exemple de demande

curl --location -g --request GET 'https://rest.iad-01.braze.com/campaigns/list?page=0&include_archived=false&sort_direction=desc&last_edit.time[gt]=2020-06-28T23:59:59-5:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Réponse

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "campaigns" : [
        {
            "id" : (string) the Campaign API identifier,
            "last_edited": (ISO 8601 string) the last edited time for the message
            "name" : (string) the campaign name,
            "is_api_campaign" : (boolean) whether the campaign is an API campaign,
            "tags" : (array) the tag names associated with the campaign formatted as strings
        },
        ...
    ]
}

tip:

Pour obtenir de l’aide sur les exportations CSV et de l’API, consultez la section Résolution des problèmes d’exportation.

Modifier cette page sur GitHub

CETTE PAGE A-T-ELLE ÉTÉ UTILE?

Modifier cette page sur GitHub

New Stuff!