Skip to main content
GET
/
reports
/
payment-metrics
Get payment metrics for analytics
curl --request GET \
  --url https://api.sprucecollective.co.uk/reports/payment-metrics \
  --header 'Authorization: <api-key>'
{
  "average_order_value_cents": 123,
  "quantity_one_orders": 123,
  "raffles_purchased": 123,
  "total_orders": 123,
  "total_quantity": 123,
  "total_value_cents": 123
}

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and JWT token.

Query Parameters

days
integer

Number of days to analyze (default: 30)

start
string

Start date (YYYY-MM-DD)

end
string

End date (YYYY-MM-DD)

site_id
string

Site ID for multi-tenant filtering

Response

200 - application/json

OK

average_order_value_cents
number
quantity_one_orders
integer
raffles_purchased
integer
total_orders
integer
total_quantity
integer
total_value_cents
integer