Skip to content

Liste der Kampagnen exportieren

get

/campaigns/list

Verwenden Sie diesen Endpunkt, um eine Liste von Kampagnen zu exportieren, die jeweils den Namen, den API-Bezeichner der Kampagne, die Angabe, ob es sich um eine API-Kampagne handelt, und die mit der Kampagne verknüpften Tags enthält.

Die Kampagnen werden in 100er-Gruppen zurückgegeben, sortiert nach Erstellungszeitpunkt (standardmäßig vom ältesten zum neuesten).

See me in Postman

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung campaigns.list.

Rate-Limit

Wir wenden auf diesen Endpunkt das standardmäßige Braze-Rate-Limit von 250.000 Anfragen pro Stunde an, wie in API-Rate-Limits dokumentiert.

Anfrageparameter

Parameter Erforderlich Datentyp Beschreibung
page Optional Integer Die Seite der zurückzugebenden Kampagnen, Standard ist 0 (gibt den ersten Satz von bis zu 100 zurück).
include_archived Optional Boolescher Wert Ob archivierte Kampagnen einbezogen werden sollen oder nicht, Standardwert ist false.
sort_direction Optional String - Erstellungszeit vom neuesten zum ältesten sortieren: Geben Sie den Wert desc ein.
- Erstellungszeit vom ältesten zum neuesten sortieren: Geben Sie den Wert asc ein.

Wenn sort_direction nicht angegeben ist, ist die Standardreihenfolge vom ältesten zum neuesten.
last_edit.time[gt] Optional Zeit Filtert die Ergebnisse und gibt nur Kampagnen zurück, die nach dem angegebenen Zeitpunkt bearbeitet wurden. Das Format ist yyyy-MM-DDTHH:mm:ss.

Beispielanfrage

1
2

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'

Antwort

1
2
3
4
5
6
7
8
9
10
11
12
13

{
    "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
        },
        ...
    ]
}
New Stuff!