Skip to content

キャンバスリストをエクスポートする

get

/canvas/list

このエンドポイントを使用して、名前、キャンバスAPI識別子、関連タグを含むキャンバスのリストをエクスポートする。

キャンバスは、作成時刻順 (デフォルトでは古い順) で並べられた 100 個のグループで返されます。

include_archived フィールドが指定されていない限り、アーカイブされたキャンバスは API 応答に含まれません。ただし、停止しているがアーカイブされていないキャンバスは、デフォルトで返却される。

前提条件

このエンドポイントを使用するには、canvas.list権限を持つ API キー が必要です。

レート制限

API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。

リクエストパラメーター

パラメーター required データ型 説明
page オプション 整数 返すキャンバスのページ、デフォルトは0 (最大100枚までの最初のセットを返す)
include_archived オプション ブール値 アーカイブされたキャンバスを含めるかどうか。デフォルトはfalse
sort_direction オプション string - 作成時刻を新しいものから古いものへと並べ替える: 値 desc を渡します。
- 作成時刻を古いものから新しいものへと並べ替える: 値 asc を渡します。

sort_direction が含まれていない場合、デフォルトの順序は古いものから新しいものとなる。
last_edit.time[gt] オプション 時刻 結果をフィルターし、現在までに指定された時間より長く編集されたキャンバスのみを返します。形式は 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
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
}
「このページはどの程度役に立ちましたか?」
New Stuff!