Get User 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
}
    ]
}

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

Show Course statistics properties

createdCoursesCount

integer

required

Number of courses created by user

publishedCoursesCount

integer

required

Number of courses published by user

sharedCoursesCount

integer

required

Number of courses shared with user

assignedCoursesCount

integer

required

Number of courses assigned to user

startedCoursesCount

integer

required

Number of courses started by user

finishedCoursesCount

integer

required

Number of courses completed by user

averageResultValue

integer

required

Average progress across all courses

virgin

array

required

Array of not started courses

Show Course item properties

course

object

required

Course information

deadlineAt

integer

required

Assignment deadline timestamp

started

array

required

Array of started courses

Show Started course properties

course

object

required

Course information

progressValue

integer

required

Current progress (0-100)

courseElement

object

required

Current course element

Show Element properties

integer

required

Element ID

name

string

required

Element name

type

string

required

Element type

updatedAt

integer

required

Last progress update timestamp

deadlineAt

integer

required

Assignment deadline timestamp

isCourseStarted

boolean

required

Course start status

isCourseFinished

boolean

required

Course completion status

results

object

required

Distribution of course results

Show Results properties

integer

Number of courses with 0% result

1-10

integer

Courses with 1-10% result

11-20

integer

Courses with 11-20% result

21-30

integer

Courses with 21-30% result

31-40

integer

Courses with 31-40% result

41-50

integer

Courses with 41-50% result

51-60

integer

Courses with 51-60% result

61-70

integer

Courses with 61-70% result

71-80

integer

Courses with 71-80% result

81-90

integer

Courses with 81-90% result

91-99

integer

Courses with 91-99% result

100

integer

Number of courses with 100% result

Error Responses

404

object

Not Found error response

Show Error object properties

status

integer

required

HTTP status code (404)

message

string

required

Error message

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
}
    ]
}

Get SSO URL List Groups

Getting Started

API Reference

Request Headers

URL Parameters

Response

Error Responses

Getting Started

API Reference

​Request Headers

​URL Parameters

​Response

​Error Responses

Request Headers

URL Parameters

Response

Error Responses