Skip to main content
GET
/
raffles
/
reports
Get raffle reports
curl --request GET \
  --url https://api.sprucecollective.co.uk/raffles/reports \
  --header 'Authorization: <api-key>'
{
  "has_more": true,
  "page": 123,
  "page_size": 123,
  "reports": [
    {
      "active": true,
      "admin_grant_customers": 123,
      "admin_grant_entries": 123,
      "average_order_value": 123,
      "avg_entries_per_customer": 123,
      "closed": true,
      "conversion_rate_percent": 123,
      "currency": "<string>",
      "customers_per_day": 123,
      "days_active": 123,
      "days_since_first_entry": 123,
      "end_date": "<string>",
      "entries_per_day": 123,
      "first_entry_date": "<string>",
      "free_entries": 123,
      "item_id": "<string>",
      "last_entry_date": "<string>",
      "max_entries_per_customer": 123,
      "min_entries_per_customer": 123,
      "paid_customers": 123,
      "paid_entries": 123,
      "paid_entry_percentage": 123,
      "paying_customers": 123,
      "point_customers": 123,
      "price_display": 123,
      "raffle_created_at": "<string>",
      "raffle_id": "<string>",
      "raffle_name": "<string>",
      "raffle_slug": "<string>",
      "repeat_customers": 123,
      "revenue_per_day": 123,
      "start_date": "<string>",
      "status": "<string>",
      "total_admin_grant_entries": 123,
      "total_admin_grant_transactions": 123,
      "total_customers": 123,
      "total_entries": 123,
      "total_paid_entries": 123,
      "total_point_entries": 123,
      "total_revenue": 123,
      "total_transactions": 123,
      "total_webflow_entries": 123,
      "webflow_customers": 123
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1

Page number

page_size
integer
default:10

Page size

status
string
default:all

Filter by status: all, active, inactive, closed, expired, upcoming

sort_by
string
default:total_revenue

Sort by field: total_revenue, total_entries, total_customers, created_at

sort_order
string
default:desc

Sort order: asc, desc

min_revenue
number

Minimum total revenue filter

min_entries
integer

Minimum total entries filter

min_customers
integer

Minimum total customers filter

Response

OK

has_more
boolean
page
integer
page_size
integer
reports
object[]
total
integer