Export Canvas details
get
/canvas/details
Use this endpoint 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
note:
All Canvas steps have a next_paths
field, which is an array of {name, next_step_id}
data. For full steps and Message steps, the next_step_ids
field will be present, but will not contain data for other Canvas Flow steps.
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
41
42
43
44
45
46
47
48
49
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"created_at": (string) the date created as ISO 8601 date,
"updated_at": (string) the date updated as ISO 8601 date,
"name": (string) the Canvas name,
"description": (string) the Canvas description,
"archived": (boolean) whether this Canvas is archived,
"draft": (boolean) whether this Canvas is a draft,
"schedule_type": (string) the type of scheduling action,
"first_entry": (string) the date of first entry as ISO 8601 date,
"last_entry": (string) the date of last entry as ISO 8601 date,
"channels": (array of strings) step channels used with Canvas,
"variants": [
{
"name": (string) the name of variant,
"id": (string) the API identifier of the variant,
"first_step_ids": (array of strings) the API identifiers for first steps in variant,
"first_step_id": (string) the 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) the tag names associated with the Canvas,
"steps": [
{
"name": (string) the name of step,
"type" (string) the type of Canvas component,
"id": (string) the API identifier of the step,
"next_step_ids": (array of strings) IDs for next steps that are full steps or Message steps,
"next_paths": { (array of objects)
// for Decision Splits, this property should evaluate to "Yes" or "No"
// for Audience Path and Action Paths, this property should evaluate to the group name
// for Experiment Paths, this property should evaluate to the path name
// for other steps, this property should evaluate to "null"
"name": (string) name the name of step,
"next_step_id": (string) IDs for next steps that are full steps or Message steps,
}
"channels": (array of strings) the channels used in step,
"messages": {
"message_variation_id": (string) { // <=This is the actual id
"channel": (string) the channel type of the message (e.g., "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.