Overview Report

Get high-level sales, booking, and customer statistics.

Endpoint

GET /v1/reports/overview

Required Scope: reports:read

Query Parameters

Parameter	Type	Default	Description
period	string	today	Time period: today, last_7_days, last_30_days

Response

{
  "data": {
    "period": "last_7_days",
    "period_start": "2026-01-08T00:00:00+00:00",
    "period_end": "2026-01-15T23:59:59+00:00",
    "sales": {
      "total_revenue": 12500.00,
      "transaction_count": 45,
      "average_transaction_value": 277.78
    },
    "bookings": {
      "created": 52,
      "confirmed": 38,
      "completed": 25,
      "cancelled": 5
    },
    "customers": {
      "new": 18,
      "returning": 27
    }
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-01-15T12:00:00+00:00"
  }
}

Response Fields

sales

Field	Type	Description
total_revenue	float	Total revenue for the period
transaction_count	integer	Number of transactions
average_transaction_value	float	Average value per transaction

bookings

Field	Type	Description
created	integer	Bookings created in period
confirmed	integer	Bookings confirmed in period
completed	integer	Bookings completed in period
cancelled	integer	Bookings cancelled in period

customers

Field	Type	Description
new	integer	First-time customers in period
returning	integer	Returning customers in period

Example Request

curl "https://app.equipdash.com/api/v1/reports/overview?period=last_7_days" \
  -H "Authorization: Bearer YOUR_API_KEY"

Use Cases

• Executive Dashboards: Display key business metrics at a glance
• Daily Reporting: Track daily sales and booking activity
• Performance Monitoring: Monitor customer acquisition trends

Related Endpoints

• Rentals Report - Detailed rental product metrics
• Experiences Report - Tour/activity performance