送信分析をエクスポートする
get
/sends/data_series
このエンドポイントを使用して、API キャンペーンに関して追跡された
send_id
のさまざまな統計の日次情報を取得します。
Braze は送信後14日間、送信分析を保存します。キャンペーンのコンバージョンは、特定のユーザーがキャンペーンから受け取った直近の send_id
に起因します。
前提条件
このエンドポイントはAPIキャンペーン専用である。このエンドポイントを使用するには、API キーとsends.data_series
の権限が必要です。
レート制限
API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。
リクエストパラメーター
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
campaign_id |
必須 | 文字列 | キャンペーン API 識別子を参照してください。 |
send_id |
必須 | 文字列 | API 識別子の送信を参照してください。 |
length |
必須 | 整数 | 返されるシリーズに ending_at が含まれるまでの最大日数。1以上100以下でなければなりません。 |
ending_at |
オプション | 日時 (ISO-8601 文字列) |
データシリーズが終了する日付。リクエストの時刻にデフォルト設定されます。 |
例のリクエスト
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/sends/data_series?campaign_id={{campaign_identifier}}&send_id={{send_identifier}}&length=30&ending_at=2014-12-10T23:59:59-05:00' \
--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
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"message": (required, string) the status of the export, returns 'success' when completed without errors,
"data" : [
{
"time": (string) the date as ISO 8601 date,
"messages": {
"ios_push" : [
{
"variation_name": (string) variation name,
"sent": (int) the number of sends,
"delivered": (int) the number of messages successfully delivered,
"undelivered": (int) the number of undelivered,
"delivery_failed": (int) the number of rejected,
"direct_opens": (int) the number of direct opens,
"total_opens": (int) the number of total opens,
"bounces": (int) the number of bounces,
"body_clicks": (int) the number of body clicks,
"revenue": (float) the number of dollars of revenue (USD),
"unique_recipients": (int) the number of unique recipients at the campaign-level,
"conversions": (int) the number of conversions,
"conversions_by_send_time": (int) the number of conversions attributed to the date the campaign was sent,
"conversions1": (optional, int) the number of conversions for the second conversion event,
"conversions1_by_send_time": (optional, int) the number of conversions for the second conversion event attributed to the date the campaign was sent,
"conversions2": (optional, int) the number of conversions for the third conversion event,
"conversions2_by_send_time": (optional, int) the number of conversions for the third conversion event attributed to the date the campaign was sent,
"conversions3": (optional, int) the number of conversions for the fourth conversion event,
"conversions3_by_send_time": (optional, int) the number of conversions for the fourth, conversion event attributed to the date the campaign was sent
}
]
},
"conversions_by_send_time": (optional, int),
"conversions1_by_send_time": (optional, int),
"conversions2_by_send_time": (optional, int),
"conversions3_by_send_time": (optional, int),
"conversions": (int),
"conversions1": (optional, int),
"conversions2": (optional, int),
"conversions3": (optional, int),
"unique_recipients": (int),
"revenue": (optional, float)
}
],
"message": "success"
}
tip:
CSV および API のエクスポートに関するヘルプについては、「エクスポートのトラブルシューティング」を参照してください。
New Stuff!