輸出仕入数
get
/purchases/quantity_series
このエンドポイントを使用して、時間範囲内でのアプリ内の購入の合計数を返します。
前提条件
このエンドポイントを使用するには、purchases.quantity_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 string) | データエクスポートを終了する日付。デフォルトは要求の時刻です。 |
length |
Required | Integer | ending_at が返される系列に含まれるまでの最大日数。1 ~100 (両端を含む) である必要があります。 |
unit |
オプション | 文字列 | データポイント間の時間の単位。day またはhour にすることができます。デフォルトはday です。 |
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 エクスポートのヘルプについては、トラブルシューティング をエクスポートしてください。