Skip to content

캔버스 목록 내보내기

get

/canvas/list

이 엔드포인트를 사용하여 이름, 캔버스 API 식별자 및 관련 태그를 포함한 캔버스 목록을 내보낼 수 있습니다.

캔버스는 생성 시간별로 정렬된 100개 그룹으로 반환됩니다(기본적으로 가장 오래된 것부터 최신 것까지).

아카이브된 캔버스는 include_archived 필드가 지정되지 않는 한 API 응답에 포함되지 않습니다. 그러나 중지되었지만 보관되지 않은 캔버스는 기본적으로 반환됩니다.

See me in Postman

필수 구성 요소

이 엔드포인트를 사용하려면 canvas.list 권한이 있는 API 키가 필요합니다.

사용량 제한

API 속도 제한에 설명된 대로 이 엔드포인트에 시간당 250,000건의 기본 Braze 속도 제한을 적용합니다.

요청 매개변수

요청 예시

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'

응답

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
}
Github   GitHub 에서 이 페이지를 편집합니다.
이 페이지가 얼마나 도움이 되었나요?
New Stuff!