Exporter la liste des Canvas

Utilisez cet endpoint pour exporter une liste de Canvas, y compris le nom, l’identifiant de l’API Canvas et les balises associées.

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

Les Canvas archivés ne seront pas inclus dans la réponse API, sauf si le champ include_archived est spécifié. En revanche, les Canvas arrêtés, mais non archivés seront renvoyés par défaut.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation canvas.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

Exemple de demande

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'

Réponse

1
2
3
4
5
6
7
8
9
10
11
12
13
14
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "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
}