BREAGEN Logo
User Management Service

User Dashboard Management

The User Dashboard Management service provides functionality to retrieve dashboard data and analytics for users.

Dashboard Operations

Get Dashboard Data GET /api/v1/dashboard

Resource URL/api/v1/dashboard
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Query Parameters

ParameterTypeRequiredDescription
timePeriodintegerYesTime period in days for dashboard data

Example Request

curl -X 'GET' \
'https://um.braegen.ai/api/v1/dashboard?timePeriod=30' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}'

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": {
		"count": [
			{
				"title": "Total Users",
				"count": 1250
			},
			{
				"title": "Active Users",
				"count": 980
			},
			{
				"title": "New Users",
				"count": 145
			}
		],
		"graph": [
			{
				"title": "User Growth",
				"data": [
					{
						"date": "2024-03-01",
						"value": 1100
					},
					{
						"date": "2024-03-15",
						"value": 1175
					},
					{
						"date": "2024-04-01",
						"value": 1250
					}
				]
			}
		]
	}
}

HTTP Response Codes

HTTP CodeMessage
200Success
400Bad Request
401Unauthorized
403Invalid Input
404Invalid or not found type

Common Error Responses

Invalid Time Period

{
	"success": false,
	"status": "400 BAD_REQUEST",
	"message": "Invalid time period value",
	"data": null
}

Authorization Error

{
	"success": false,
	"status": "401 UNAUTHORIZED",
	"message": "Invalid or expired token",
	"data": null
}

On this page