Skip to content

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.

See me in Postman

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.
ending_at Required Datetime
(ISO-8601 string)		 Date on which the data export should end. Defaults to time of the request.
starting_at Optional* Datetime
(ISO-8601 string)		 Date on which the data export should begin.

* Either length or starting_at is required.
length Optional* String Maximum number of days before ending_at to include in the returned series. Must be between 1 and 14 (inclusive).

* Either length or starting_at is required.
include_variant_breakdown Optional Boolean Whether or not to include variant stats (defaults to false).
include_step_breakdown Optional Boolean Whether or not to include step stats (defaults to false).
include_deleted_step_data Optional Boolean Whether or not to include step stats for deleted steps (defaults to false).

Example request

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/canvas/data_summary?canvas_id={{canvas_id}}&ending_at=2018-05-30T23: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
}
  Edit this page on GitHub
WAS THIS PAGE HELPFUL?
New Stuff!