Esta página fue traducida automáticamente y puede contener errores. Para informar de un error de traducción, usa el componente de comentarios situado bajo el sumario, a la derecha de la página.

Exportar análisis de resumen de datos de Canvas

get

/canvas/data_summary

Utiliza este endpoint 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 endpoint, 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 endpoint, 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`).

Importante

Los análisis de Canvas se agregan por día en la zona horaria configurada por tu empresa en Braze (la misma zona horaria que utiliza el panel). La API normaliza starting_at y ending_at a medianoche en esa zona horaria. Asegúrate de que tus marcas de tiempo estén alineadas 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 las 12 am UTC+2.

Ejemplo de solicitud

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

Campos de eventos de conversión

La respuesta incluye un par de campos de conversión por cada evento de conversión configurado en el Canvas. El evento de conversión primaria utiliza conversions y conversions_by_entry_time. Cada evento adicional utiliza el mismo nombre base con un sufijo numérico que comienza en 1 para el segundo evento y aumenta en uno por cada evento adicional.

Orden del evento de conversión en el Canvas	Campo de conversiones	Campo por tiempo de entrada
Primario	`conversions`	`conversions_by_entry_time`
Segundo	`conversions1`	`conversions1_by_entry_time`
Tercero	`conversions2`	`conversions2_by_entry_time`
Cuarto	`conversions3`	`conversions3_by_entry_time`

El quinto evento y los posteriores siguen el mismo patrón (por ejemplo, conversions4 y conversions4_by_entry_time). Estos campos aparecen en total_stats y, cuando solicitas desgloses, en variant_stats y step_stats con los mismos nombres.

Nota

En total_stats, variant_stats y step_stats, conversions es el recuento del evento de conversión primaria del Canvas. Cuando configuras eventos de conversión adicionales, la carga útil también puede incluir conversions1, conversions2 y campos con índices superiores para el segundo, tercer y posteriores eventos. Esto es similar a la respuesta multivariante del endpoint /campaigns/data_series. Cuando están presentes, los campos que terminan en _by_entry_time atribuyen esas conversiones por el momento de entrada al Canvas.

{
  "data": {
    "name": (string) the Canvas name,
    "total_stats": {
      "revenue": (float) the number of dollars of revenue (USD),
      "entries": (int) the number of entries,
      "conversions": (int) the number of conversions for the primary conversion event,
      "conversions_by_entry_time": (int) the number of conversions for the primary conversion event by entry time,
      "conversions1": (optional, int) the number of conversions for the second conversion event,
      "conversions1_by_entry_time": (optional, int) the number of conversions for the second conversion event by entry time,
      "conversions2": (optional, int) the number of conversions for the third conversion event,
      "conversions2_by_entry_time": (optional, int) the number of conversions for the third conversion event by entry time,
      "conversions3": (optional, int) the number of conversions for the fourth conversion event,
      "conversions3_by_entry_time": (optional, int) the number of conversions for the fourth conversion event by entry time
    },
    "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 for the primary conversion event,
        "conversions_by_entry_time": (optional, int) the number of conversions for the primary conversion event by entry time,
        "conversions1": (optional, int) the number of conversions for the second conversion event,
        "conversions1_by_entry_time": (optional, int) the number of conversions for the second conversion event by entry time,
        "conversions2": (optional, int) the number of conversions for the third conversion event,
        "conversions2_by_entry_time": (optional, int) the number of conversions for the third conversion event by entry time,
        "conversions3": (optional, int) the number of conversions for the fourth conversion event,
        "conversions3_by_entry_time": (optional, int) the number of conversions for the fourth conversion event by entry time,
        "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 for the primary conversion event,
        "conversions_by_entry_time": (int) the number of conversions for the primary conversion event by entry time,
        "conversions1": (optional, int) the number of conversions for the second conversion event,
        "conversions1_by_entry_time": (optional, int) the number of conversions for the second conversion event by entry time,
        "conversions2": (optional, int) the number of conversions for the third conversion event,
        "conversions2_by_entry_time": (optional, int) the number of conversions for the third conversion event by entry time,
        "conversions3": (optional, int) the number of conversions for the fourth conversion event,
        "conversions3_by_entry_time": (optional, int) the number of conversions for the fourth 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": (string) returns 'success' when the request completes without errors
}