Export Canvas data summary analytics

get

/canvas/data_summary

Use this endpoint allows to export rollups of time series data for a Canvas, providing a concise summary of Canvas results.

See me in Postman

Prerequisites

To use this endpoint, you’ll need an API key with the canvas.data_summary permission.

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 statistics (defaults to false).

include_step_breakdown Optional Boolean Whether or not to include step statistics (defaults to false).

include_deleted_step_data Optional Boolean Whether or not to include step statistics for deleted steps (defaults to false).

Example request

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-05:00&starting_at=2018-05-28T23:59:59-05:00&length=5&include_variant_breakdown=true&include_step_breakdown=true&include_deleted_step_data=true' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Response

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "data": {
    "name": (string) the Canvas name,
    "total_stats": {
      "revenue": (float) the number of dollars of revenue (USD),
      "conversions": (int) the number of conversions,
      "conversions_by_entry_time": (int) the number of conversions for the conversion event by entry time,
      "entries": (int) the number of entries
    },
    "variant_stats": (optional) {
      "00000000-0000-0000-0000-0000000000000": (string) the API identifier for the variant {
        "name": (string) the name of variant,
        "revenue": (float) the number of dollars of revenue (USD),
        "conversions": (int) the number of conversions,
        "entries": (int) the number of entries
      },
      ... (more variants)
    },
    "step_stats": (optional) {
      "00000000-0000-0000-0000-0000000000000": (string) the API identifier for the step {
        "name": (string) the name of step,
        "revenue": (float) the number of dollars of revenue (USD),
        "conversions": (int) the number of conversions,
        "conversions_by_entry_time": (int) the number of conversions for the conversion event by entry time,
        "messages": {
          "android_push": (name of channel) [
            {
              "sent": (int) the number of sends,
              "opens": (int) the number of opens,
              "influenced_opens": (int) the number of influenced opens,
              "bounces": (int) the number of bounces
              ... (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 Export troubleshooting.

Edit this page on GitHub

HOW HELPFUL WAS THIS PAGE?

Edit this page on GitHub

New Stuff!