Exportar análisis de resumen de datos de Canvas

get

/canvas/data_summary

El uso de este punto final permite exportar rollups de datos de series temporales para un Canvas, proporcionando un resumen conciso de los resultados del Canvas.

See me in Postman

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 en la que debe finalizar la exportación de datos. De forma predeterminada, la hora de la solicitud.

starting_at Opcional*. Fecha y hora
(cadena ISO-8601) Fecha en la que debe comenzar 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 a incluir en la serie devuelta. Debe estar comprendido entre 1 y 14 (ambos inclusive).

* Se requiere length o starting_at.

include_variant_breakdown Opcional Booleano Incluir o no estadísticas de variantes (por defecto false).

include_step_breakdown Opcional Booleano Incluir o no estadísticas de pasos (por defecto false).

include_deleted_step_data Opcional Booleano Incluir o no las estadísticas de los pasos eliminados (por defecto false).

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

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:

Para obtener ayuda con las exportaciones CSV y API, visita Solución de problemas de exportación.

Editar esta página en GitHub

¿QUÉ TAN ÚTIL FUE ESTA PÁGINA?

Editar esta página en GitHub

New Stuff!