Canvas Data Summary Endpoint
get
/canvas/data_summary
This endpoint allows you to export rollups of time series data for a Canvas, providing a concise summary of a Canvas’ results.
important:
Looking for the api_key parameter?
As of May 2020, Braze has changed how we read API keys to be more secure. Now API keys must be passed as a request header, please see YOUR_REST_API_KEY within the Example Request below.
Braze will continue to support the api_key being passed through the request body and URL parameters, but will eventually be sunset. Please update your API calls accordingly.
Request Parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
canvas_id |
Yes | String | Canvas API Identifier |
ending_at |
Yes | DateTime (ISO 8601 string) | Date on which the data export should end - defaults to time of the request |
starting_at |
No | DateTime (ISO 8601 string) | Date on which the data export should begin (either length or starting_at required) |
length |
No | String | Max number of days before ending_at to include in the returned series - must be between 1 and 14 inclusive (either length or starting_at required) |
include_variant_breakdown |
No | Boolean | Whether or not to include variant stats (defaults to false) |
include_step_breakdown |
No | Boolean | Whether or not to include step stats (defaults to false) |
include_deleted_step_data |
No | Boolean | Whether or not to include step stats for deleted steps (defaults to false) |
Request Components
Example Request
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/canvas/data_summary?canvas_id=3bbc4555-8fa0-4c9b-a5c0-4505edf3e064&ending_at=2018-06-28T23:59:59-5:00&starting_at=2018-05-28T23:59:59-5:00&length=5&include_variant_breakdown=true&include_step_breakdown=true&include_deleted_step_data=true' \
--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
41
42
43
44
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"data": {
"name": (string) Canvas name,
"total_stats": {
"revenue": (float),
"conversions": (int),
"conversions_by_entry_time": (int),
"entries": (int)
},
"variant_stats": (optional) {
"00000000-0000-0000-0000-0000000000000": (API identifier for variant) {
"name": (string) name of variant,
"revenue": (float),
"conversions": (int),
"entries": (int)
},
... (more variants)
},
"step_stats": (optional) {
"00000000-0000-0000-0000-0000000000000": (API identifier for step) {
"name": (string) name of step,
"revenue": (float),
"conversions": (int),
"conversions_by_entry_time": (int),
"messages": {
"android_push": (name of channel) [
{
"sent": (int),
"opens": (int),
"influenced_opens": (int),
"bounces": (int)
... (more stats for channel)
}
],
... (more channels)
}
},
... (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 our troubleshooting article here.
Edit this page on GitHub