Skip to content

Exportar lista de Canvas

get

/canvas/list

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

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

Los Canvas archivados no se incluirán en la respuesta de la API a menos que se especifique el campo include_archived. Sin embargo, los Canvas detenidos pero no archivados se devolverán de forma predeterminada.

See me in Postman

Requisitos previos

Para utilizar este punto de conexión, 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 de conexión, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Parámetro Obligatorio Tipo de datos Descripción
page Opcional Entero La página de Canvas a devolver, predeterminada a 0 (devuelve el primer conjunto de hasta 100).
include_archived Opcional Booleano Incluir o no los Canvas archivados, de forma predeterminada es false.
sort_direction Opcional Cadena - Ordenar la hora de creación de más reciente a más antigua: introduce el valor desc.
- Ordenar la hora de creación de más antigua a más reciente: introduce el valor asc.

Si no se incluye sort_direction, el orden predeterminado es de más antiguo a más reciente.
last_edit.time[gt] Opcional Tiempo Filtra los resultados y solo devuelve los Canvas que se hayan editado después del tiempo indicado hasta ahora. El formato es yyyy-MM-DDTHH:mm:ss.

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

{
  "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!