Skip to main content
GET
/
payments
/
stats
Get payment statistics
curl --request GET \
  --url https://api.sprucecollective.co.uk/payments/stats \
  --header 'Authorization: <api-key>'
{}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
period
string

Time period: 'day', 'week', 'month', 'year', 'all' (default: 'all')

​
month
integer

Month (1-12) for month filtering

​
year
integer

Year for month filtering

​
gateway
string

Filter by gateway

​
status
string

Filter by status

​
utm_source
string

Filter by UTM source

​
utm_campaign
string

Filter by UTM campaign

​
start
string

Start date (YYYY-MM-DD)

​
end
string

End date (YYYY-MM-DD)

Response

OK

The response is of type object.