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

{
    "group": {
    "id": 123,
    "name": "Marketing Team",
    "parentId": null,
    "usersCount": 25,
    "coursesCount": 10,
    "image": null,
    "attributes": {}
},
    "usersWithoutActivity": [
{
    "id": "user1",
    "name": "John Smith",
    "email": "john@example.com",
    "role": {
    "alias": "learner"
}
}
    ],
    "usersWithoutResults": [
{
    "id": "user2",
    "name": "Jane Doe",
    "email": "jane@example.com",
    "role": {
    "alias": "learner"
}
}
    ],
    "leaders": [
{
    "coursesCount": 8,
    "resultValue": 95,
    "user": {
    "id": "user3",
    "name": "Mike Johnson",
    "email": "mike@example.com",
    "role": {
    "alias": "learner"
}
}
}
    ]
}

Retrieve detailed statistics and analytics information for a specific group.

​
Path Parameters

​
groupId
integer
required

The unique identifier of the group to get statistics for

​
Request Headers

​
X-API-KEY
string
required

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

​
Response

​
group
object
required

Basic group information

​
usersWithoutActivity
array
required

List of users with no activity in the group

​
usersWithoutResults
array
required

List of users who haven’t completed any assessments

​
leaders
array
required

Top performing users in the group

​
Error Responses

​
404
object

Returned when the group is not found

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

{
    "group": {
    "id": 123,
    "name": "Marketing Team",
    "parentId": null,
    "usersCount": 25,
    "coursesCount": 10,
    "image": null,
    "attributes": {}
},
    "usersWithoutActivity": [
{
    "id": "user1",
    "name": "John Smith",
    "email": "john@example.com",
    "role": {
    "alias": "learner"
}
}
    ],
    "usersWithoutResults": [
{
    "id": "user2",
    "name": "Jane Doe",
    "email": "jane@example.com",
    "role": {
    "alias": "learner"
}
}
    ],
    "leaders": [
{
    "coursesCount": 8,
    "resultValue": 95,
    "user": {
    "id": "user3",
    "name": "Mike Johnson",
    "email": "mike@example.com",
    "role": {
    "alias": "learner"
}
}
}
    ]
}