Skip to content

Canvas 목록 내보내기

get

/canvas/list

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

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

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

See me in Postman

필수 조건

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

사용량 제한

이 엔드포인트에는 API 사용량 제한 설명서에 명시된 대로 기본 Braze 사용량 제한인 시간당 250,000건의 요청이 적용됩니다.

요청 매개변수

매개변수 필수 데이터 유형 설명
page 선택 사항 정수 반환할 Canvases 페이지이며, 기본값은 0입니다(최대 100개의 첫 번째 세트를 반환).
include_archived 선택 사항 부울 아카이브된 Canvases를 포함할지 여부이며, 기본값은 false입니다.
sort_direction 선택 사항 문자열 - 생성 시간을 최신에서 오래된 순으로 정렬: desc 값을 전달합니다.
- 생성 시간을 가장 오래된 것부터 최신 순으로 정렬: asc 값을 전달합니다.

sort_direction이 포함되지 않은 경우 기본 순서는 가장 오래된 것부터 최신 순입니다.
last_edit.time[gt] 선택 사항 시간 결과를 필터링하여 제공된 시간 이후에 편집된 Canvases만 반환합니다. 형식은 yyyy-MM-DDTHH:mm:ss입니다.

요청 예시

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

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