GET /v1/dashboard
Get main dashboard data
Returns comprehensive dashboard data including today's reservations, upcoming bookings, revenue stats, and unread notifications
Request
GET /v1/dashboard
Parameters
[]
Response
{
"200": {
"description": "Dashboard data retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"full_name": {
"type": "string"
},
"company_name": {
"type": "string"
},
"role": {
"type": "string"
}
},
"required": [
"id",
"full_name",
"company_name",
"role"
]
},
"today_reservations": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total_revenue": {
"type": "number"
},
"check_ins": {
"type": "number"
},
"check_outs": {
"type": "number"
}
},
"required": [
"count",
"total_revenue",
"check_ins",
"check_outs"
]
},
"upcoming_reservations": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"next_7_days": {
"type": "number"
},
"next_30_days": {
"type": "number"
}
},
"required": [
"count",
"next_7_days",
"next_30_days"
]
},
"properties": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"active": {
"type": "number"
}
},
"required": [
"total",
"active"
]
},
"rooms": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"occupied": {
"type": "number"
},
"available": {
"type": "number"
}
},
"required": [
"total",
"occupied",
"available"
]
},
"notifications": {
"type": "object",
"properties": {
"unread_count": {
"type": "number"
},
"recent": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"type",
"title",
"created_at"
]
}
}
},
"required": [
"unread_count",
"recent"
]
},
"revenue": {
"type": "object",
"properties": {
"this_month": {
"type": "number"
},
"last_month": {
"type": "number"
},
"growth_percentage": {
"type": "number"
}
},
"required": [
"this_month",
"last_month",
"growth_percentage"
]
}
},
"required": [
"user",
"today_reservations",
"upcoming_reservations",
"properties",
"rooms",
"notifications",
"revenue"
]
}
},
"required": [
"success",
"data"
]
}
}
}
}
}
View in Interactive API Reference