Skip to content

Exportar análisis de resumen de datos de Canvas

get

/canvas/data_summary

Utiliza este punto de conexión para exportar resúmenes de datos de series temporales para un Canvas, lo que proporciona un resumen conciso de los resultados del Canvas.

See me in Postman

Requisitos previos

Para utilizar este punto de conexión, necesitarás una clave de API con el permiso canvas.data_summary.

Límite de velocidad

Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto de conexión, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Parámetro Obligatorio Tipo de datos Descripción
canvas_id Obligatorio Cadena Ver identificador de API de Canvas.
ending_at Obligatorio Fecha y hora
(cadena ISO-8601)		 Fecha de finalización de la exportación de datos. Se predetermina a la hora de la solicitud.
starting_at Opcional* Fecha y hora
(cadena ISO-8601)		 Fecha de inicio de la exportación de datos.

* Se requiere length o starting_at.
length Opcional* Cadena Número máximo de días antes de ending_at incluidos en la serie devuelta. Debe estar comprendido entre 1 y 14 (ambos inclusive).

* Se requiere length o starting_at.
include_variant_breakdown Opcional Booleano Si se deben incluir estadísticas de variantes (el valor predeterminado es false).
include_step_breakdown Opcional Booleano Si se deben incluir estadísticas de pasos (el valor predeterminado es false).
include_deleted_step_data Opcional Booleano Si se deben incluir estadísticas de pasos para los pasos eliminados (el valor predeterminado es false).

Ejemplo de solicitud

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-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'

Respuesta

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

{
  "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 the 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 the 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 total number of opens (includes both direct opens and 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' on successful completion
}
New Stuff!