キャンバスデータ系列分析をエクスポート
get
/canvas/data_series
このエンドポイントを使用して、キャンバスの時系列データをエクスポートします。
前提条件
このエンドポイントを使用するには、API キーとcanvas.data_series
の権限が必要です。
レート制限
API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。
リクエストパラメーター
パラメータ | required | データ型 | 説明 |
---|---|---|---|
canvas_id |
必須 | string | キャンバス API 識別子を参照してください。 |
ending_at |
required | 日時 (ISO-8601 文字列) |
データエクスポートを終了する日付。リクエストの時刻にデフォルト設定されます。 |
starting_at |
任意* | 日時 (ISO-8601 文字列) |
データエクスポートを開始する日付。 * length または starting_at のいずれかが必要です。 |
length |
任意* | string | 返されるシリーズに ending_at が含まれるまでの最大日数。1以上14以下でなければなりません。* length または starting_at のいずれかが必要です。 |
include_variant_breakdown |
オプション | ブール値 | バリアント統計を含めるかどうか(デフォルトはfalse )。 |
include_step_breakdown |
オプション | ブール値 | ステップ統計を含めるかどうか(デフォルトはfalse )。 |
include_deleted_step_data |
オプション | ブール値 | 削除されたステップのステップ統計を含めるかどうか(デフォルトはfalse )。 |
例のリクエスト
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'
応答
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:
CSVおよびAPIエクスポートのヘルプについては、エクスポートのトラブルシューティングを参照してください。
New Stuff!