Canvas Data Series Analytics Endpoint

get

/canvas/data_series

This endpoint allows you to export time series data for a Canvas.

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 are 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/sends/data_series?campaign_id=3bbc4555-8fa0-4c9b-a5c0-4505edf3e064&send_id=3456789&length=30&ending_at=2014-12-10T23:59:59-05:00' \
--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
45
46
47
48
49
50
51
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
  "data": {
    "name": (string) Canvas name,
    "stats": [
      {
        "time": (string) date as ISO 8601 date,
        "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": (int),
            "conversions": (int),
            "conversions_by_entry_time": (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": {
              "email": [
                {
                  "sent": (int),
                  "opens": (int),
                  "unique_opens": (int),
                  "clicks": (int),
                  ... (more stats)
                }
              ],
              ... (more channels)
            }
          },
          ... (more steps)
        }
      },
      ... (more stats by time)
    ]
  },
  "message": (required, string) the status of the export, returns 'success' when completed without errors
}
WAS THIS PAGE HELPFUL?
New Stuff!