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โ
| Parameter | Type | Default | Description |
|---|---|---|---|
period | string | today | Time 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โ
| Field | Type | Description |
|---|---|---|
total_revenue | float | Total rental revenue |
total_bookings | integer | Number of rental bookings |
average_rental_duration_days | float | Average rental period in days |
utilization_rate | float | Inventory utilization percentage |
By Categoryโ
| Field | Type | Description |
|---|---|---|
category_id | integer | Category ID |
category_name | string | Category name |
revenue | float | Revenue from category |
bookings | integer | Number of bookings |
items_rented | integer | Total items rented |
Top Productsโ
| Field | Type | Description |
|---|---|---|
id | integer | Product ID |
name | string | Product name |
sku | string | SKU |
revenue | float | Total revenue |
bookings | integer | Number of bookings |
units_rented | integer | Total units rented |
average_duration_days | float | Average rental duration |
Errorsโ
| Status | Code | Description |
|---|---|---|
| 401 | authentication_required | No API key provided |
| 403 | insufficient_scope | API 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..."