GET /products/{productId}/metrics - Fanfare Documentation

GET

products

{productId}

metrics

cURL

curl --request GET \
  --url https://admin.fanfare.io/api/products/{productId}/metrics \
  --header 'Authorization: Bearer <token>'

{
  "orderCount": 123,
  "revenue": "<string>",
  "unitsSold": 123,
  "lastOrderAt": "<string>"
}

Authorization

string

header

required

Fanfare secret key. Keep secret credentials on your server.

productId

string

required

Product sales metrics retrieved successfully

orderCount

number

required

revenue

string

required

Pattern: ^\d{1,12}(\.\d{1,8})?$

unitsSold

number

required

lastOrderAt

string | null

cURL

curl --request GET \
  --url https://admin.fanfare.io/api/products/{productId}/metrics \
  --header 'Authorization: Bearer <token>'

{
  "orderCount": 123,
  "revenue": "<string>",
  "unitsSold": 123,
  "lastOrderAt": "<string>"
}