キャンバスリストの書き出し

get

/canvas/list

このエンドポイントを使用して、名前、Canvas API ID、および関連するタグを含むCanvase のリストをエクスポートします。

キャンバスは、作成時にソートされた100 個のグループで返されます(デフォルトでは最も古いものから最新のもの)。

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

See me in Postman

前提条件

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

レート制限

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

要求パラメータ

パラメータ	必須	データ型	説明
`page`	オプション	整数	返されるキャンバスのページ。デフォルトは`0` (100 までの最初のセットを返します)
`include_archived`	オプション	ブール	アーカイブされたキャンバスを含めるかどうかに関係なく、デフォルトは`false`	です。
`sort_direction`	オプション	String	- 作成時刻を最新から最も古い順に並べ替えます。値`desc` を渡します。 - 作成時刻を最も古いものから最新のものにソートするには、`asc` の値を渡します。 `sort_direction` が含まれていない場合、デフォルトの順序は最も古い順から最新の順になります。
`last_edit.time[gt]`	Optional	Time	結果をフィルタリングし、これまでに指定された時間よりも大きい時間に編集されたキャンバスのみを返します。フォーマットは`yyyy-MM-DDTHH:mm:ss`です。

リクエスト例

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'

レスポンス

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
}

tip:

CSV およびAPI エクスポートのヘルプについては、トラブルシューティングをエクスポートしてください。

Edit this page on GitHub

HOW HELPFUL WAS THIS PAGE?

Edit this page on GitHub