ニュースフィードカード分析のエクスポート
get
/feed/data_series
このエンドポイントを使用して、時間の経過に伴うカードの日次エンゲージメント統計を取得します。
note:
ニュースフィードは非推奨になります。Brazeでは、ニュースフィードツールをご利用のお客様には、柔軟性、カスタマイズ性、信頼性に優れたコンテンツカードメッセージングチャネルへの移行を推奨しています。詳しくは、 移行ガイド をご覧ください。
前提 条件
このエンドポイントを使用するには、アクセス許可を持つ feed.data_series
API キーが必要です。
レート制限
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
要求パラメーター
パラメータ | 必須項目 | データ型 | 説明 |
---|---|---|---|
card_id |
必須項目 | 文字列 | 「カード API 識別子」を参照してください。 特定のカードの API card_id キー ページとダッシュボード内のカードの詳細ページ、または ニュースフィード カード リストのエクスポート エンドポイントを使用できます。 |
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 のエクスポートに関するヘルプについては、 エクスポートのトラブルシューティングをご覧ください。