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

get

/toile/résumé_des_données

Utilisez cet endpoint pour exporter des cumuls de données de série temporelles pour un Canvas, fournissant ainsi un résumé concis des résultats de 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

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

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 à laquelle l’exportation de données doit se terminer. Par défaut, l’heure de la demande.

starting_at En option* DateTime
chaîne (ISO-8601) Date à laquelle l’exportation de données doit commencer.

* L’adresse length ou starting_at est requise.

length En option* Chaîne de caractères Nombre maximum de jours avant ending_at à inclure 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 S’il faut inclure ou non des statistiques de variante (par défaut sur false).

include_step_breakdown Facultatif Valeur booléenne S’il faut inclure ou non des statistiques d’étape (par défaut sur false).

include_deleted_step_data Facultatif Valeur booléenne S’il faut inclure ou non des statistiques d’étape pour les étapes supprimées (par défaut sur false).

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

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:

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

CETTE PAGE A-T-ELLE ÉTÉ UTILE?

Modifier cette page sur GitHub

New Stuff!