Reports API
The Reports API provides read-only access to business analytics and performance metrics.
Available Reportsโ
| Report | Description | Best For |
|---|---|---|
| Overview | High-level sales and booking stats | Executive dashboards |
| Rentals | Product rental performance | Inventory analysis |
| Experiences | Tour/activity performance | Activity optimization |
Time Periodsโ
All reports support three time periods:
| Period | Description |
|---|---|
today | Current day only |
last_7_days | Previous 7 days |
last_30_days | Previous 30 days |
API Endpointsโ
Read-only, except custom reports
The built-in reports are read-only aggregated data. Custom reports can also be created and changed.
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/reports/overview | Sales and booking summary | reports:read |
GET | /v1/reports/rentals | Rental product metrics | reports:read |
GET | /v1/reports/experiences | Experience metrics | reports:read |
GET | /v1/reports/custom | Reports the business built itself (create and change with reports:write) | reports:read |
Overview Reportโ
High-level business metrics:
Overview Report
โโโ Sales
โ โโโ Total revenue
โ โโโ Transaction count
โ โโโ Average transaction value
โโโ Bookings
โ โโโ Total created
โ โโโ Confirmed / Completed / Cancelled
โโโ Customers
โโโ New customers
โโโ Returning customers
Rentals Reportโ
Product rental performance:
Rentals Report
โโโ Summary
โ โโโ Total revenue
โ โโโ Total bookings
โ โโโ Average rental duration
โ โโโ Utilization rate
โโโ By Category
โ โโโ Revenue, bookings, items per category
โโโ Top Products
โโโ Revenue, bookings, units rented per product
Experiences Reportโ
Tour and activity performance:
Experiences Report
โโโ Summary
โ โโโ Total revenue
โ โโโ Total bookings
โ โโโ Total participants
โ โโโ Average group size
โ โโโ Capacity utilization
โโโ By Category
โ โโโ Revenue, bookings, participants per category
โโโ Top Experiences
โโโ Revenue, bookings, utilization per experience
Common Use Casesโ
Building a Dashboardโ
Fetch overview data for your dashboard:
curl "https://app.equipdash.com/api/v1/reports/overview?period=last_7_days" \
-H "Authorization: Bearer YOUR_API_KEY"
Analyzing Product Performanceโ
Identify your best-performing rentals:
curl "https://app.equipdash.com/api/v1/reports/rentals?period=last_30_days" \
-H "Authorization: Bearer YOUR_API_KEY"
Tracking Tour Capacityโ
Monitor experience utilization:
curl "https://app.equipdash.com/api/v1/reports/experiences?period=last_30_days" \
-H "Authorization: Bearer YOUR_API_KEY"
Key Metrics Explainedโ
| Metric | Description |
|---|---|
utilization_rate | % of inventory/capacity actually used |
average_rental_duration | Average days per rental |
average_group_size | Average participants per experience booking |
capacity_utilization | % of available experience spots filled |
Related Resourcesโ
- Bookings - Raw booking data for custom reports
- Products - Product details
- Experiences - Experience details