User Activity Summary
This end point is use for get user activity summary by employee ID
[GET] /ruangkerja/dashboard/users/:employeeID/activity-summary
Information
This API contains information activities Course & Learning Plan by User in Ruangkerja.
See also API: User.
Headers
| Name | Type | Example | Required | Description |
|---|---|---|---|---|
| Authorization | string | access_token | YES | Token of authentication. Get from Authentication API |
| Accept | string | application/json | YES | Defines the message format that is expected by the client |
| Content-Type | string | application/json | YES | Defines the message format of the request body that is sent by the client |
Parameter
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
| employeeID | string | YES | path | Employee ID of User |
Example cURL Request
curl --location --request GET 'https://api.ruangkerja.id/ruangkerja/dashboard/users/JOHNILXV3QAJJEL3/activity-summary' \
--header 'Authorization: access_token'
Example Success Response
{
"status": "success",
"message": "Success",
"data": {
"user": {
"serial": "JOHNILXV3QAJJEL3",
"name": "John Doe",
"employeeID": "EMPLY001"
"email": "john.doe@example.com",
"tags": ["Jakarta", "QualityAsurance"],
"organizationLevelDisplayName": "Ruangkerja > Marketing",
"organizationLevelSerial": "COMP33K4C0HD",
"lastAccessMission": "2021-08-10 07:40:53"
},
"numberOfCoursesAssigned": 24,
"numberOfCoursesCompleted": 1,
"numberOfCoursesExpired": 8,
"numberOfCoursesFailed": 1,
"numberOfCoursesInProgress": 0,
"numberOfCoursesNotStarted": 14,
"overallProgress": 5,
"avgPostTest": 80,
"avgPreTest": 0,
"timeSpent": 0
}
}
Response Body Terminology
| Location | Type | Description |
|---|---|---|
| data.*.overallProgress | int | The value represent in percentage of user progress |
| data.*.timeSpent | int | The value represent time spend in seconds |
Example Failed Response
{
"errorCode": 123,
"message": "rpc error: code = PermissionDenied desc = Token is not valid",
"detail": "rpc error: code = PermissionDenied desc = Token is not valid"
}
See also: Error Dictionary.