購入数をエクスポート
get
/purchases/quantity_series
このエンドポイントを使用して、アプリ内の購入総数を期間内に返します。
前提条件
このエンドポイントを使用するには、API キーとpurchases.quantity_series
の権限が必要です。
レート制限
リクエストパラメーター
パラメーター | required | データ型 | 説明 |
---|---|---|---|
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/quantity_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,
"purchase_quantity" : (int) the number of items purchased in the time period
},
...
]
}
tip:
CSV および API のエクスポートに関するヘルプについては、「エクスポートのトラブルシューティング」を参照してください。
New Stuff!