36360learning
Paths

List all user statistics for all paths

Changed on

🔑

Required OAuth scope: pathStats:read.

📖

This endpoint is paginated with a page size of 2,000 path user statistics. For more information, see the Pagination guide.

Lists all user statistics for paths in the platform.

get/api/v2/paths/stats

Request

  • Base URL
    https://app.360learning.com
  • URL
    https://app.360learning.com/api/v2/paths/stats
  • Auth
    OAuth 2
    Client credentials
    Token URL: /api/v2/oauth2/token

Query parameters

eq'archived' | 'published'

Filter on values equal to the given one

Filter on status property with LHS bracket notation.

Expected value format is a string (archived, published).

{
  "eq": "archived"
}
ltstring date-time

Filter on dates lower than the given one

gtestring date-time

Filter on dates greater than or equal the given one

Filter on completedAt property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

{
  "lt": "2020-01-01T10:30:26.000Z",
  "gte": "2020-01-01T10:30:26.000Z"
}
eqstring ObjectId

Filter on values equal to the given one

nestring ObjectId

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on pathId property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

{
  "eq": "507f1f77bcf86cd799439011",
  "ne": "507f1f77bcf86cd799439011",
  "in": [
    "507f1f77bcf86cd799439011"
  ],
  "nin": [
    "507f1f77bcf86cd799439011"
  ]
}
eqstring ObjectId

Filter on values equal to the given one

nestring ObjectId

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on userId property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

{
  "eq": "507f1f77bcf86cd799439011",
  "ne": "507f1f77bcf86cd799439011",
  "in": [
    "507f1f77bcf86cd799439011"
  ],
  "nin": [
    "507f1f77bcf86cd799439011"
  ]
}

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 2000 path user statistics.

_idstring ObjectId required

The unique ID of the user enrollment.

progressinteger required

The completion rate of the user as a percentage.

timeSpentnumber required

The number of milliseconds spent by the user on the session.

userIdstring ObjectId required

The unique ID of the user.

completedAtstring date-time

The date and time of completion of the session, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

scoreinteger

The score obtained by the user as a percentage.

enrolledAtstring date-time required

The date and time the user was enrolled, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

unenrolledAtstring date-time

The date and time the user was unenrolled, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

certificateIdstring ObjectId

The ID of the certificate obtained by the user in the session.

selfEnrolledboolean required

True if the user self-enrolled in the given path session; false otherwise.

startedAtstring date-time

The date and time the user started working in the session, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

dueDatestring date-time

The date and time when the session is due, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

lockedAtstring date-time

The date and time the statistics of the user were locked, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)). Locked statistics no longer evolve when the path or its steps are updated. The statistics of a user are locked only if the Lock learner statistics option is activated on the path, and either the user has completed the path (Successful or Unsuccessful status) or the path session has ended. This field is absent if the statistics of the user are not locked.

pathIdstring ObjectId required

The unique ID of the path.

sessionIdstring ObjectId required

The unique ID of the path session.

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "userId": "507f1f77bcf86cd799439011",
    "certificateId": "507f1f77bcf86cd799439011",
    "pathId": "507f1f77bcf86cd799439011",
    "sessionId": "507f1f77bcf86cd799439011"
  }
]

Changes