Exporter l’analyse des séries de données de Canvas
get
/canvas/data_series
Utilisez cet endpoint pour exporter des données de série temporelles pour un Canvas.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation canvas.data_series.
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
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/canvas/data_series?canvas_id={{canvas_id}}&ending_at=2018-05-30T23:59:59-5:00&starting_at=2018-05-28T23:59:59-5:00&include_variant_breakdown=true&include_step_breakdown=true&include_deleted_step_data=true' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
Réponse
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"data": {
"name": (string) the Canvas name,
"stats": [
{
"time": (string) the date as ISO 8601 date,
"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,
"conversions_by_entry_time": (int) the number of conversions for the 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 step,
"revenue": (float) the the number of dollars of revenue (USD),
"conversions": (int) the the number of conversions,
"conversions_by_entry_time": (int) the number of conversions for the conversion event by entry time,
"messages": {
"email": [
{
"sent": (int) the number of sends,
"opens": (int) the number of opens,
"unique_opens": (int) the number of unique opens,
"clicks": (int) the number of clicks
... (more stats)
}
],
"sms" : [
{
"sent": (int) the number of sends,
"sent_to_carrier" : (int) the number of messages sent to the carrier,
"delivered": (int)the number of delivered messages,
"rejected": (int) the number of rejected messages,
"delivery_failed": (int) the number of failed deliveries,
"clicks": (int) the number of clicks on shortened links,
"opt_out" : (int) the number of opt outs,
"help" : (int) the number of help messages received
}
],
... (more channels)
}
},
... (more steps)
}
},
... (more stats by time)
]
},
"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?
New Stuff!