Canvas details endpoint
get
/canvas/details
This endpoint allows you to export metadata about a Canvas, such as the name, time created, current status, and more.
Rate limit
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
Request parameters
Parameter | Required | Data Type | Description |
---|---|---|---|
canvas_id |
Required | String | See Canvas API Identifier |
Example request
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/canvas/details?canvas_id={{canvas_identifier}}' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"created_at": (string) date created as ISO 8601 date,
"updated_at": (string) date updated as ISO 8601 date,
"name": (string) Canvas name,
"description": (string) Canvas description,
"archived": (boolean) whether this Canvas is archived,
"draft": (boolean) whether this Canvas is a draft,
"schedule_type": (string) type of scheduling action,
"first_entry": (string) date of first entry as ISO 8601 date,
"last_entry": (string) date of last entry as ISO 8601 date,
"channels": (array of strings) step channels used with Canvas,
"variants": [
{
"name": (string) name of variant,
"id": (string) API identifier of the variant,
"first_step_ids": (array of strings) API identifiers for first steps in variant,
"first_step_id": (string) API identifier of first step in variant (deprecated in November 2017, only included if the variant has only one first step)
},
... (more variations)
],
"tags": (array of strings) tag names associated with the Canvas,
"steps": [
{
"name": (string) name of step,
"id": (string) API identifier of the step,
"next_step_ids": (array of strings) API identifiers of steps following step,
"channels": (array of strings) channels used in step,
"messages": {
"message_variation_id": (string) { // <=This is the actual id
"channel": (string) channel type of the message (eg., "email"),
... channel-specific fields for this message, see Campaign Details Endpoint API Response for example message responses ...
}
}
},
... (more steps)
],
"message": (required, string) the status of the export, returns 'success' when completed without errors
}
tip:
For help with CSV and API exports, visit Export troubleshooting.