Exportar análisis de resumen de datos de Canvas
/canvas/data_summary
Utiliza este punto final para exportar resúmenes de datos de series temporales para un Canvas, lo que proporciona un resumen conciso de los resultados del Canvas.
Requisitos previos
Para utilizar este punto final, 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 final, como se documenta en Límites de velocidad de la API.
Parámetros de la solicitud
| Parámetro | Obligatoria | Tipo de datos | Descripción |
|---|---|---|---|
canvas_id |
Obligatoria | Cadena | Ver identificador de API de Canvas. |
ending_at |
Obligatoria | Fecha y hora (cadena ISO-8601) |
Fecha de finalización de la exportación de datos. Predeterminada 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 deending_atser incluido 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 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). |
Alineación de zonas horarias: Los análisis del panel de Braze se agregan diariamente en la zona horaria configurada por tu empresa en el panel de Braze. Asegúrate de que tus marcas de tiempo coincidan con la zona horaria de tu empresa para que tus estadísticas coincidan con el panel. Por ejemplo, si la hora de tu empresa es UTC+2, la marca de tiempo debería ser 12:00 a. m. UTC+2.
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
}
influenced_opens campo: En la respuesta de la API, elinfluenced_openscampo representa el número total de aperturas (tanto directas como Influenced Opens combinadas). En el panel de Braze, «Influenced Opens» se refiere únicamente a las aperturas influenciadas, excluyendo las aperturas directas. Esto se debe a una convención de nomenclatura heredada en la API.
Para obtener ayuda con las exportaciones CSV y API, visita Solución de problemas de exportación.
Editar esta página en GitHub