時間ごとの収益データのエクスポート
get
/purchases/revenue_series
このエンドポイントを使用して、時間範囲にわたってアプリで使用された合計金額を返します。
前提条件
このエンドポイントを使用するには、purchases.revenue_series
パーミッションを持つAPI キーが必要です。
レート制限
For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the /custom_attributes
, /events
, and /events/list
endpoints, as documented in API rate limits.
リクエストパラメータ
パラメータ|必須|データ型|説明 |
---|
ending_at |任意|日時(ISO-8601文字列)|データ・エクスポートを終了する日付。デフォルトはリクエスト時刻。 |
length |必須|整数|返されるシリーズに含めるending_at までの最大日数。1~100の間でなければならない。 |
unit |オプション|文字列|データポイント間の時間の単位。デフォルトは日。 |
app_id |任意|文字列|API Keysページから取得したアプリAPI識別子。除外すると、ワークスペース内のすべてのアプリの結果が返されます。 |
product |任意|文字列|応答をフィルタリングする製品名。除外した場合は、すべてのアプリの結果が返されます。 |
リクエスト例
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エクスポートに関するヘルプは、エクスポートのトラブルシューティングをご覧ください。