Get User Statistics | Tangerine365

curl -X POST https://localhost:8090/api/user/userStats \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" \
     -d "idst=user_987654321"

{
  "data": {
    "general": {
      "name": "johndoe92",
      "user_type": "Student",
      "member_since": "2022-03-15 09:45:30"
    },
    "last_login": "2024-06-10 14:22:10",
    "course_attendance": {
      "others": 1,
      "waiting": 2,
      "completed": 5,
      "suspended": 0,
      "subscribed": 8,
      "in-progress": 2,
      "not-started": 3,
      "overbooking": 0,
      "total_courses": 13,
      "subscription_to_confirm": 1
    },
    "certificates_attained": 4,
    "competencies_attained": 7
  },
  "success": true
}

The POST /api/user/userStatsendpoint is used to retrieve user statistics in the application courses based on the user’name.

Request

Method: POST
Base URL: {{baseUrl}}
Path: /api/user/userStats
Headers:
- Content-Type: application/x-www-form-urlencoded
Body:
- idst (text): User ID
- auth (text): The authentication token

Response

success (boolean): Indicates the success of the request.
data (object)
- general (object):
  - name: user’s username
  - user_type: Type of user
  - member_since: Date user was registered
- course_attendance:
  - subscribed: number of courses user is subscribed to.
  - in _progress: number of courses currently in progress by user.
  - completed: number of completed courses
  - total_courses: total number of courses associated with the user
- competencies_attained: number of competencies attained.
- certificates_attained: number of certificates attained.
- last_login: Last login date/time for the user

The `POST /api/user/userStats`endpoint is used to retrieve user statistics in the application courses based on the user'name. ### Request - Method: POST - Base URL: {{baseUrl}} - Path: /api/user/userStats - Headers: - Content-Type: application/x-www-form-urlencoded - Body: - `idst` (text): User ID - `auth` (text): The authentication token ### Response - `success` (boolean): Indicates the success of the request. - `data` (object) - `general` (object): - `name`: user's username - `user_type`: Type of user - `member_since`: Date user was registered - `course_attendance:` - `subscribed`: number of courses user is subscribed to. - `in _progress`: number of courses currently in progress by user. - `completed`: number of completed courses - `total_courses`: total number of courses associated with the user - `competencies_attained:` number of competencies attained. - `certificates_attained:` number of certificates attained. - `last_login:` Last login date/time for the user

Request

This endpoint expects an object.

authstringRequired

idststringRequired

Response headers

Keep-Alivestring

X-Powered-Bystring

Response

dataobject

successboolean

The POST /api/user/userStatsendpoint is used to retrieve user statistics in the application courses based on the user’name.

Request

Method: POST
Base URL: {{baseUrl}}
Path: /api/user/userStats
Headers:
- Content-Type: application/x-www-form-urlencoded
Body:
- idst (text): User ID
- auth (text): The authentication token

Response

success (boolean): Indicates the success of the request.
data (object)
- general (object):
  - name: user’s username
  - user_type: Type of user
  - member_since: Date user was registered
- course_attendance:
  - subscribed: number of courses user is subscribed to.
  - in _progress: number of courses currently in progress by user.
  - completed: number of completed courses
  - total_courses: total number of courses associated with the user
- competencies_attained: number of competencies attained.
- certificates_attained: number of certificates attained.
- last_login: Last login date/time for the user