Skip to main content

Reports API

The Reports API provides read-only access to business analytics and performance metrics.

Available Reportsโ€‹

ReportDescriptionBest For
OverviewHigh-level sales and booking statsExecutive dashboards
RentalsProduct rental performanceInventory analysis
ExperiencesTour/activity performanceActivity optimization

Time Periodsโ€‹

All reports support three time periods:

PeriodDescription
todayCurrent day only
last_7_daysPrevious 7 days
last_30_daysPrevious 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.

MethodEndpointDescriptionScope Required
GET/v1/reports/overviewSales and booking summaryreports:read
GET/v1/reports/rentalsRental product metricsreports:read
GET/v1/reports/experiencesExperience metricsreports:read
GET/v1/reports/customReports 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โ€‹

MetricDescription
utilization_rate% of inventory/capacity actually used
average_rental_durationAverage days per rental
average_group_sizeAverage participants per experience booking
capacity_utilization% of available experience spots filled