Skip to main content
GET
/
api
/
v1
/
users
/
me
/
analytics
/
overview
Get Overview
curl --request GET \
  --url https://api.seamind.xyz/api/v1/users/me/analytics/overview \
  --header 'Authorization: Bearer <token>'
{
  "metrics": {
    "totalCourses": 123,
    "completedCourses": 123,
    "inProgressCourses": 123,
    "notStartedCourses": 123,
    "failedCourses": 123,
    "averageScore": 123,
    "highestScore": 123,
    "lowestScore": 123,
    "totalTimeSeconds": 123,
    "lastActivityAt": "2023-11-07T05:31:56Z"
  },
  "scoreDistribution": [
    {
      "range": "<string>",
      "count": 123
    }
  ],
  "statusBreakdown": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

Dashboard overview response with metrics, score distribution, status breakdown.

metrics
DashboardMetricsDTO · object
required

Aggregated metrics for learner dashboard.

scoreDistribution
ScoreBucketDTO · object[]
required
statusBreakdown
Statusbreakdown · object
required