Exportar lista de Canvas

Use este endpoint para exportar uma lista de Canvas, incluindo o nome, o identificador de API do Canvas e as tags associadas.

Os Canvas são retornados em grupos de 100, classificados por data de criação (do mais antigo ao mais recente por padrão).

Canvas arquivados não serão incluídos na resposta da API, a menos que o campo include_archived seja especificado. Canvas que estão parados, mas não arquivados, no entanto, serão retornados por padrão.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão canvas.list.

Limite de taxa

Aplicamos o limite de taxa padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de taxa da API.

Parâmetros de solicitação

Exemplo de solicitação

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'

Resposta

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
}