Exporter le résumé analyse des données de Canvas

get

/canvas/data_summary

Veuillez utiliser cet endpoint pour exporter des synthèses de données chronologiques pour un canvas, fournissant ainsi un résumé concis des résultats du canvas.

See me in Postman

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation canvas.data_summary.

Limite de débit

Nous appliquons la limitation du débit Braze par défaut de 250 000 requêtes par heure à cet endpoint, comme documenté dans Limites de débit de l’API.

Paramètres de demande

Paramètre Requis Type de données Description

canvas_id Requis Chaîne de caractères Voir l’identifiant de l’API Canvas.

ending_at Requis DateTime
chaîne (ISO-8601) Date de fin pour l’exportation des données. La valeur par défaut correspond à l’heure de la demande.

starting_at En option* DateTime
chaîne (ISO-8601) Date de début de l’exportation des données.

* L’adresse length ou starting_at est requise.

length En option* Chaîne de caractères Nombre maximal de jours avantending_atd’être inclus dans la série renvoyée. Doit être compris entre 1 et 14 (inclus).

* L’adresse length ou starting_at est requise.

include_variant_breakdown Facultatif Valeur booléenne Si l’on souhaite inclure les statistiques des variantes (valeur par défaut : false).

include_step_breakdown Facultatif Valeur booléenne Si l’on souhaite inclure les statistiques par étape (valeur par défaut : false).

include_deleted_step_data Facultatif Valeur booléenne Si vous souhaitez inclure les statistiques des étapes supprimées (valeur par défaut : false).

important:

Alignement des fuseaux horaires : Les analyses du tableau de bord de Braze sont agrégées quotidiennement dans le fuseau horaire configuré pour votre entreprise dans le tableau de bord. Veuillez vous assurer que vos horodatages correspondent au fuseau horaire de votre entreprise afin que vos statistiques correspondent au tableau de bord. Par exemple, si l’heure de votre entreprise est UTC+2, l’horodatage devrait être 12 h UTC+2.

Exemple de demande

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'

Réponse

{
  "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
}

important:

influenced_opens domaine : Dans la réponse API, leinfluenced_openschamp représente le nombre total d’ouvertures (ouvertures directes et influencées combinées). Dans le tableau de bord de Braze, le terme « ouvertures influencées » désigne uniquement les ouvertures influencées, à l’exclusion des ouvertures directes. Cela est dû à une convention de nommage héritée dans l’API.

tip:

Pour obtenir de l’aide sur les exportations CSV et de l’API, consultez la section Résolution des problèmes d’exportation.

Modifier cette page sur GitHub

New Stuff!