Skip to main content
GET
/
api
/
public
/
v1
/
analytics
/
training
Get training analytics
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/analytics/training \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "overview": {
      "totalCourses": 123,
      "mandatoryCourses": 123,
      "totalEnrollments": 123,
      "completedEnrollments": 123,
      "inProgressEnrollments": 123,
      "completionRate": 123,
      "averageScore": 123,
      "averageTimeSpentSeconds": 123
    },
    "courseTypes": {},
    "monthlyCompletions": [
      {
        "month": "<string>",
        "completions": 123
      }
    ],
    "topPerformers": [
      {
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "email": "<string>",
        "totalEnrolled": 123,
        "completed": 123,
        "completionRate": 123
      }
    ],
    "coursesNeedingAttention": [
      {
        "courseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "totalEnrollments": 123,
        "completed": 123,
        "completionRate": 123
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

​
companyId
string<uuid>

Filter by company ID

Response

Training analytics

​
data
object
required