購入数をエクスポート

get

/purchases/quantity_series

このエンドポイントを使用して、アプリ内の購入総数を期間内に返します。

前提条件

このエンドポイントを使用するには、API キーとpurchases.quantity_seriesの権限が必要です。

レート制限

リクエストパラメーター

パラメータ	required	データ型	説明
`ending_at`	オプション	日時 (ISO-8601 文字列)	データエクスポートを終了する日付。リクエストの時刻にデフォルト設定されます。
`length`	required	整数	返されるシリーズに `ending_at` が含まれるまでの最大日数。1以上100以下でなければなりません。
`unit`	オプション	string	データポイント間の時間単位。日または時間にすることができ、デフォルトは日です。
`app_id`	オプション	string	API キーページから取得したアプリ API 識別子。除外された場合、ワークスペース内のすべてのアプリの結果が返されます。
`product`	オプション	string	応答をフィルターする製品の名前。除外された場合、すべてのアプリの結果が返されます。

例のリクエスト

curl --location --request GET 'https://rest.iad-01.braze.com/purchases/quantity_series?length=100' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

応答

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エクスポートのヘルプについては、エクスポートのトラブルシューティングを参照してください。

GitHub でこのページを編集

「このページはどの程度役に立ちましたか?」

GitHub でこのページを編集

New Stuff!