GET
/
users
/
{userId}
/
statistics
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users/1234567890/statistics' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "courses": {
    "sharedCoursesCount": 5,
    "assignedCoursesCount": 10,
    "startedCoursesCount": 8,
    "finishedCoursesCount": 6,
    "averageResultValue": 85
},
    "virgin": [
{
    "course": {
    "id": 123,
    "name": "Introduction to Sales",
    "annotation": "Basic sales concepts",
    "isDraft": false
},
    "deadlineAt": 1704067200
}
    ],
    "started": [
{
    "course": {
    "id": 124,
    "name": "Advanced Sales Techniques",
    "annotation": "Advanced sales strategies",
    "isDraft": false
},
    "progressValue": 75,
    "courseElement": {
    "id": 456,
    "name": "Customer Psychology",
    "type": "page"
},
    "updatedAt": 1673531200,
    "deadlineAt": 1704067200,
    "isCourseStarted": true,
    "isCourseFinished": false
}
    ],
    "results": {
    "0": 2,
    "1-10": 0,
    "11-20": 1,
    "21-30": 0,
    "31-40": 1,
    "41-50": 0,
    "51-60": 1,
    "61-70": 2,
    "71-80": 1,
    "81-90": 1,
    "91-99": 0,
    "100": 1
},
    "tags": [
{
    "tagId": 1,
    "tag": "Sales",
    "resultValue": 85
},
{
    "tagId": 2,
    "tag": "Communication",
    "resultValue": 90
}
    ]
}

Retrieve comprehensive statistics about a user’s learning activities, including course progress, test results, and performance metrics.

​
Request Headers

​
X-API-KEY
string
required

API Key. Go to your Konstantly site > Settings > API and copy the value from there.

​
URL Parameters

​
userId
string
required

User API ID

​
Response

​
courses
object
required

General course statistics

​
virgin
array
required

Array of not started courses

​
started
array
required

Array of started courses

​
results
object
required

Distribution of course results

​
tags
array
required

Performance statistics by tag

​
Error Responses

​
404
object

Not Found error response

curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users/1234567890/statistics' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "courses": {
    "sharedCoursesCount": 5,
    "assignedCoursesCount": 10,
    "startedCoursesCount": 8,
    "finishedCoursesCount": 6,
    "averageResultValue": 85
},
    "virgin": [
{
    "course": {
    "id": 123,
    "name": "Introduction to Sales",
    "annotation": "Basic sales concepts",
    "isDraft": false
},
    "deadlineAt": 1704067200
}
    ],
    "started": [
{
    "course": {
    "id": 124,
    "name": "Advanced Sales Techniques",
    "annotation": "Advanced sales strategies",
    "isDraft": false
},
    "progressValue": 75,
    "courseElement": {
    "id": 456,
    "name": "Customer Psychology",
    "type": "page"
},
    "updatedAt": 1673531200,
    "deadlineAt": 1704067200,
    "isCourseStarted": true,
    "isCourseFinished": false
}
    ],
    "results": {
    "0": 2,
    "1-10": 0,
    "11-20": 1,
    "21-30": 0,
    "31-40": 1,
    "41-50": 0,
    "51-60": 1,
    "61-70": 2,
    "71-80": 1,
    "81-90": 1,
    "91-99": 0,
    "100": 1
},
    "tags": [
{
    "tagId": 1,
    "tag": "Sales",
    "resultValue": 85
},
{
    "tagId": 2,
    "tag": "Communication",
    "resultValue": 90
}
    ]
}