GET /v1/admin/reports
Get platform reports
Returns platform-wide statistics and reports (Platform Admin only)
Request
GET /v1/admin/reports
Parameters
[
{
"schema": {
"type": "string",
"enum": [
"7d",
"30d",
"90d",
"1y"
],
"default": "30d"
},
"required": false,
"name": "period",
"in": "query"
}
]
Response
{
"200": {
"description": "Reports retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"overview": {
"type": "object",
"properties": {
"total_users": {
"type": "number"
},
"active_subscriptions": {
"type": "number"
},
"total_companies": {
"type": "number"
},
"total_properties": {
"type": "number"
},
"total_rooms": {
"type": "number"
},
"total_reservations": {
"type": "number"
},
"platform_revenue": {
"type": "number"
}
},
"required": [
"total_users",
"active_subscriptions",
"total_companies",
"total_properties",
"total_rooms",
"total_reservations",
"platform_revenue"
]
},
"growth": {
"type": "object",
"properties": {
"new_users": {
"type": "number"
},
"new_subscriptions": {
"type": "number"
},
"new_companies": {
"type": "number"
},
"revenue_growth": {
"type": "number"
}
},
"required": [
"new_users",
"new_subscriptions",
"new_companies",
"revenue_growth"
]
},
"top_customers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"full_name": {
"type": "string"
},
"email": {
"type": "string"
},
"companies_count": {
"type": "number"
},
"total_revenue": {
"type": "number"
},
"subscription_value": {
"type": "number"
}
},
"required": [
"user_id",
"full_name",
"email",
"companies_count",
"total_revenue",
"subscription_value"
]
}
},
"package_distribution": {
"type": "array",
"items": {
"type": "object",
"properties": {
"package_name": {
"type": "string"
},
"subscriber_count": {
"type": "number"
},
"percentage": {
"type": "number"
},
"revenue": {
"type": "number"
}
},
"required": [
"package_name",
"subscriber_count",
"percentage",
"revenue"
]
}
}
},
"required": [
"overview",
"growth",
"top_customers",
"package_distribution"
]
}
},
"required": [
"success",
"data"
]
}
}
}
},
"403": {
"description": "Platform admin access required"
}
}
View in Interactive API Reference