ニュースフィードカード分析をエクスポートする
get
/feed/data_series
このエンドポイントを使用して、時間の経過に伴うカードのエンゲージメント統計の日次情報を取得します。
important:
News Feed is being deprecated. We recommend migrating to our Content Cards messaging channel instead—it’s more flexible, customizable, and reliable. To get started, check out Migrating from News Feed.
前提条件
このエンドポイントを使用するには、API キーとfeed.data_series
の権限が必要です。
レート制限
API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。
リクエストパラメーター
パラメーター | required | データ型 | 説明 |
---|---|---|---|
card_id |
必須 | 文字列 | カード API 識別子を参照してください。 指定したカードの card_id は、API キーページやダッシュボード内のカード詳細ページで確認できるほか、ニュースフィードカードリストのエクスポートエンドポイントも使用できます。 |
length |
必須 | 整数 | 返されるシリーズに ending_at が含まれるまでの最大単位数 (日または時間)。1以上100以下でなければなりません。 |
unit |
オプション | 文字列 | データポイント間の時間の単位。day または hour にすることができ、デフォルトは day です。 |
ending_at |
オプション | 日時 (ISO-8601 文字列) |
データシリーズが終了する日付。リクエストの時刻にデフォルト設定されます。 |
例のリクエスト
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/feed/data_series?card_id={{card_identifier}}&length=14&unit=day&ending_at=2018-06-28T23:59:59-5:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
応答
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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 point in time - as ISO 8601 extended when unit is "hour" and as ISO 8601 date when unit is "day",
"clicks" : (int) the number of clicks,
"impressions" : (int) the number of impressions,
"unique_clicks" : (int) the number of unique clicks,
"unique_impressions" : (int) the number of unique impressions
},
...
]
}
tip:
CSV および API のエクスポートに関するヘルプについては、「エクスポートのトラブルシューティング」を参照してください。
New Stuff!