Exportar lista de Canvas

Utiliza este punto final para exportar una lista de Canvas, incluyendo el nombre, el identificador de la API de Canvas y las etiquetas asociadas.

Los lienzos se devuelven en grupos de 100 ordenados por fecha de creación (de más antiguo a más reciente por predeterminado).

Los lienzos archivados no se incluirán en la respuesta de la API a menos que se especifique el campo include_archived. Sin embargo, los lienzos parados pero no archivados se devolverán predeterminadamente.

Requisitos previos

Para utilizar este punto final, necesitarás una clave de API con el permiso canvas.list.

Límite de velocidad

Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto final, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Ejemplo de solicitud

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'

Respuesta

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
}