Skip to content

キャンバスデータのサマリー分析をエクスポート

get

/canvas/data_summary

このエンドポイントを使用すると、キャンバスの時系列データのロールアップをエクスポートでき、キャンバスの結果の簡潔な概要を提供します。

See me in Postman

前提条件

このエンドポイントを使用するには、API キーとcanvas.data_summaryの権限が必要です。

レート制限

API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。

リクエストパラメーター

パラメータ 必須 データ型 説明
canvas_id 必須 文字列 キャンバス API 識別子を参照してください。
ending_at 必須 日時
（ISO-8601 文字列）		 データエクスポートを終了する日付。リクエストの時刻にデフォルト設定されます。
starting_at オプション* 日時
（ISO-8601 文字列）		 データエクスポートを開始する日付。

* length または starting_at のいずれかが必要です。
length オプション* 文字列 返されるシリーズに 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_summary?canvas_id={{canvas_id}}&ending_at=2018-05-30T23:59:59-5:00&starting_at=2018-05-28T23:59:59-5:00&length=5&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

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
}
Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!