Skip to content

Canvas-Liste exportieren

get

/canvas/list

Verwenden Sie diesen Endpunkt, um eine Liste von Canvases zu exportieren, einschließlich des Namens, des Canvas-API-Bezeichners und der zugehörigen Tags.

Canvases werden in Gruppen von 100 zurückgegeben, sortiert nach dem Zeitpunkt der Erstellung (standardmäßig vom ältesten zum neuesten).

Archivierte Canvases werden nicht in die API-Antwort aufgenommen, es sei denn, das Feld include_archived ist angegeben. Canvases, die angehalten, aber nicht archiviert wurden, werden jedoch standardmäßig zurückgegeben.

See me in Postman

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung canvas.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 Canvases, die zurückgegeben werden soll. Standard ist 0 (gibt den ersten Satz von bis zu 100 zurück).
include_archived Optional Boolescher Wert Ob archivierte Canvases einbezogen werden sollen oder nicht. Standard 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 Canvases 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/canvas/list?page=1&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

{
  "canvases" : [
  	{
  		"id" : (string) the Canvas API identifier,
  		"last_edited": (ISO 8601 string) the last edited time for the message,
  		"name" : (string) the Canvas name,
  		"tags" : (array) the tag names associated with the Canvas formatted as strings,
  	},
    ... (more Canvases)
  ],
  "message": (required, string) the status of the export, returns 'success' when completed without errors
}
New Stuff!