Skip to main content

Rentals Report

Get detailed rental product performance metrics.

Endpointโ€‹

GET /v1/reports/rentals

Authenticationโ€‹

Requires an API key with the reports:read scope.

Query Parametersโ€‹

ParameterTypeDefaultDescription
periodstringtodayTime period: today, last_7_days, last_30_days

Responseโ€‹

Success (200 OK)โ€‹

{
"data": {
"period": "last_30_days",
"period_label": "Last 30 Days",
"summary": {
"total_revenue": 18500.00,
"total_bookings": 125,
"average_rental_duration_days": 2.3,
"utilization_rate": 68.5
},
"by_category": [
{
"category_id": 1,
"category_name": "Bikes",
"revenue": 8500.00,
"bookings": 55,
"items_rented": 82
},
{
"category_id": 2,
"category_name": "Water Sports",
"revenue": 6200.00,
"bookings": 45,
"items_rented": 52
},
{
"category_id": 3,
"category_name": "Camping Gear",
"revenue": 3800.00,
"bookings": 25,
"items_rented": 48
}
],
"top_products": [
{
"id": 1,
"name": "Mountain Bike",
"sku": "MTB-001",
"revenue": 4200.00,
"bookings": 28,
"units_rented": 42,
"average_duration_days": 2.1
},
{
"id": 3,
"name": "Kayak",
"sku": "KYK-001",
"revenue": 3100.00,
"bookings": 22,
"units_rented": 28,
"average_duration_days": 1.5
}
]
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-01-15T12:00:00+00:00"
}
}

Response Fieldsโ€‹

Summary Objectโ€‹

FieldTypeDescription
total_revenuefloatTotal rental revenue
total_bookingsintegerNumber of rental bookings
average_rental_duration_daysfloatAverage rental period in days
utilization_ratefloatInventory utilization percentage

By Categoryโ€‹

FieldTypeDescription
category_idintegerCategory ID
category_namestringCategory name
revenuefloatRevenue from category
bookingsintegerNumber of bookings
items_rentedintegerTotal items rented

Top Productsโ€‹

FieldTypeDescription
idintegerProduct ID
namestringProduct name
skustringSKU
revenuefloatTotal revenue
bookingsintegerNumber of bookings
units_rentedintegerTotal units rented
average_duration_daysfloatAverage rental duration

Errorsโ€‹

StatusCodeDescription
401authentication_requiredNo API key provided
403insufficient_scopeAPI key lacks reports:read scope

Example Requestโ€‹

curl -X GET "https://app.equipdash.com/api/v1/reports/rentals?period=last_30_days" \
-H "Authorization: Bearer eqd_live_abc123xyz789..."