API documentation
Activity Logs
Admin
- POSTCopy raffle to new site
- POSTCreate site configuration
- POSTCreate subscription tier (admin)
- POSTCreate wheel segment (admin)
- GETDebug raffle user entries
- DELDelete site configuration
- DELDelete subscription tier (admin)
- DELDelete wheel segment (admin)
- GETGet site configuration
- GETGet subscription tier (admin)
- GETList site configurations
- GETList subscription tiers (admin)
- GETList wheel segments (admin)
- POSTTop up user points for specific users and raffle
- PUTUpdate site configuration
- PUTUpdate subscription tier (admin)
- PUTUpdate wheel segment (admin)
Admin Subscriptions
Analytics
Auth
Discount Brands
Discount Codes
- Add tag to discount code
- POSTBulk generate discount codes
- GETClaim discount bonus and redirect
- Claim discount code
- POSTCreate discount code
- POSTCreate tag
- DELDelete discount code
- DELDelete tag
- GETGet discount claims report
- Get active discount codes
- Get all discount codes
- GETGet discount code
- GETGet discount code claims
- Get discount code analytics
- Get discount code by slug
- GETGet discount code with user claims
- GETGet imported offer IDs
- Get my discount claims
- Get my spins
- Get tags
- GETGet user discount code claims
- GETGet user discount code claims by user ID
- GETList discount codes
- GETList tags
- POSTRedeem discount code
- POSTRefresh discount claims materialized views
- Remove tag from discount code
- Spin discount wheel
- PUTUpdate discount code
- PUTUpdate tag
Merch
- GETAdmin list merch orders by site
- POSTCreate draft merch order
- POSTCreate merch product
- DELDelete merch product
- GETGet a merch order by id
- GETGet merch product
- GETGet merch product by item_id
- GETGet merch product by slug
- GETGet Prodigi order status
- GETList merch products
- GETList my merch orders
- POSTProdigi webhook callback
- PUTUpdate merch product
Payments
- POSTCreate NOMU Pay order or process completed order
- POSTCreate payment
- POSTCreate Revolut order
- GETDebug URL generation
- GETGet NOMU Pay order details
- GETGet NOMU Pay order status
- GETGet payment
- GETGet payment history
- GETGet payment statistics
- GETGet payments by user
- GETGet Revolut order details
- GETGet Revolut order status
- POSTHandle NOMU Pay webhook
- POSTHandle Revolut webhook
- POSTHandle webhook
- GETList all payments
- POSTRefund a NOMU Pay payment
- POSTUpdate NOMU Pay order status
Points
- POSTAdjust points
- POSTAward points
- GETGet all purchase history
- GETGet daily points activity
- GETGet points balance
- GETGet points by raffle
- GETGet points by user
- GETGet points history
- GETGet points system summary
- GETGet purchase history
- GETGet user points balance (admin)
- POSTRedeem points
- POSTSync all user points
- POSTSync points for a user
Raffles
- POSTCreate checkout session
- POSTCreate raffle
- DELDelete raffle
- POSTDraw winners
- GETGet checkout status
- GETGet my entries
- GETGet raffle
- GETGet raffle by item_id
- GETGet raffle by slug
- GETGet raffle points
- GETGet raffle reports
- GETGet raffle user entries
- GETGet single raffle report
- GETGet winners
- POSTHandle Revolut webhook
- POSTJoin raffle
- GETList raffles
- POSTPurchase raffle entries with points
- POSTSubmit free raffle entry
- POSTSync raffles from Webflow
- PUTUpdate raffle
- POSTValidate checkout response
Reports
- GETGet daily quantity distribution analysis
- GETGet daily raffle revenue analysis
- GETGet daily revenue analysis with analytics
- GETGet hourly heatmap data
- GETGet payment metrics for analytics
- GETGet quantity distribution analysis
- GETGet returning customers report
- GETGet top products report
- GETGet user growth analysis
Rewards
Subscriptions
Users
Get hourly heatmap data
Copy
curl --request GET \
--url https://api.sprucecollective.co.uk/reports/hourly-heatmap \
--header 'Authorization: <api-key>'Copy
{}Reports
Get hourly heatmap data
Returns hourly heatmap data showing orders and revenue by hour and weekday
GET
/
reports
/
hourly-heatmap
Get hourly heatmap data
Copy
curl --request GET \
--url https://api.sprucecollective.co.uk/reports/hourly-heatmap \
--header 'Authorization: <api-key>'Copy
{}Authorizations
Type "Bearer" followed by a space and JWT token.
Query Parameters
Number of days to analyze (default: 30)
Start date (YYYY-MM-DD)
End date (YYYY-MM-DD)
Site ID for multi-tenant filtering
Response
200 - application/json
OK
The response is of type object.
⌘I