時間別売上データのエクスポート
get
/purchases/revenue_series
このエンドポイントを使用して、ある期間にわたってアプリに費やされた総金額を返します。
前提条件
このエンドポイントを使用するには、purchases.revenue_series
権限を持つAPI キー が必要です。
レート制限
リクエストパラメーター
パラメータ | required | データ型 | 説明 |
---|---|---|---|
ending_at |
オプション | 日時(ISO-8601 文字列) | データエクスポートを終了する日付。デフォルトはリクエストの時刻です。 |
length |
required | 整数 | 返される系列に含めるending_at の前の最大日数。1以上100以下でなければなりません。 |
unit |
オプション | string | データポイント間の時刻の単位。日、または時間を指定できます。デフォルトは日です。 |
app_id |
オプション | string | API Keys ページから取得したアプリケーションAPI 識別子。除外すると、ワークスペース内のすべてのアプリs の結果が返されます。 |
product |
オプション | string | 応答をフィルタリングする商品の名称。除外すると、すべてのアプリs の結果が返されます。 |
リクエスト例
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/purchases/revenue_series?length=100' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
応答
1
2
3
4
5
6
7
8
9
10
11
12
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,
"revenue" : (int) amount of revenue for the time period
},
...
]
}
tip:
CSV および API のエクスポートに関するヘルプについては、「エクスポートのトラブルシューティング」を参照してください。
New Stuff!