List Completed Study Sessions

GET /sessions/completed

Provides a general purpose endpoint to search Completed Study Sessions.

The date range is limited to a maximum of 12 months, if no filters are provided it defaults to the last 12 months.

Date Range Behavior:

If no date filters are provided, it defaults to the last 12 months.
If only endDate[lte] is provided, endDate[gte] will default to 12 months prior to endDate[lte].
If only endDate[gte] is provided, endDate[lte] will default to 12 months after endDate[gte].

Nugget Filters:

Nugget filters are combined when used together. For example, specifying both nuggetId and a courseId will include nuggets from both the specified IDs and the course.

User Filters:

User filters are combined when used together and allow you to specify users by userId, externalId, or classId. When using classId, the results will include study sessions for all users within the specified class.

Query parameters

endDate object

Filter the results by session end date

Supports either a ISO 8601 formatted date or a Unix timestamp. For example endDate[gte]=1688200245 or endDate[lte]=2023-07-15T12:00:00.000Z
Hide endDate attributes Show endDate attributes object
- gte integer(int32) | string(date-time)
  
  One of:
  Timestamp integer(int32) DateTime string(date-time)
- lte integer(int32) | string(date-time)
  
  One of:
  Timestamp integer(int32) DateTime string(date-time)
userId array[string(uuid)]

Filter the results by user ID.

Multiple identifiers can be specified by repeating the query parameter. e.g. userId=value1&userId=value2

This parameter supports a maximum of 30 identifiers.

At least 1 but not more than 30 elements.
externalId array[string]

Filter the results by external ID.

Multiple identifiers can be specified by repeating the query parameter. e.g. externalId=value1&externalId=value2

This parameter supports a maximum of 30 identifiers.

At least 1 but not more than 30 elements.
nuggetId array[string(uuid)]

Filter the results by nugget ID.

Multiple identifiers can be specified by repeating the query parameter. e.g. nuggetId=value1&nuggetId=value2

This parameter supports a maximum of 30 identifiers.

At least 1 but not more than 30 elements.
classId string(uuid)

Filter the results by class ID.
courseId string(uuid)

Filter the results by course ID.
sort object

Specify the sort order of the results.

The default sort order is sort[field]=endDate&sort[direction]=asc
Hide sort attributes Show sort attributes object
- field string
  
  The available sort fields.
  
  Value is endDate. Default value is endDate.
- direction string
  
  The sort direction used for ordering the results. Can be "asc" (ascending) or "desc" (descending).
  
  Values are asc or desc.
limit integer(int32)

The maximum number of sessions to return per page.

Minimum value is 1, maximum value is 250. Default value is 100.
offset integer(int32)

Indicates the starting position or index (offset)

Default value is 0.
cursor string(byte) | null

The cursor for pagination. Encoded byte string used to navigate between pages.

Responses

200 application/json

List of Study Sessions
Hide response attributes Show response attributes object
- data array[object] Required
  
  One of:
  CompletedGradedStudySession object CompletedNonGradedStudySession object
  
  A study session that has a score
  
  Hide attributes Show attributes
  
  studySessionId string Required
  
  Study Session UUID.
  
  kind string Required Discriminator
  
  Value is GRADED.
  
  user object Required
  
  User that has completed the study session
  
  Hide user attributes Show user attributes object
  
  userId string(uuid) Required
  
  User UUID.
  
  username string Required
  
  The username of the user.
  
  upn string
  
  The Unique Pupil Number (UPN) of the user.
  
  externalId string
  
  Identifier from an external source
  
  fullName string Required
  
  The full name of the user.
  
  firstName string Required
  
  The first name of the user.
  
  middleName string
  
  The middle name of the user.
  
  lastName string Required
  
  The last name of the user.
  
  emails array[string(email)]
  
  A list of all email addresses associated with the user.
  
  gender string Required
  
  The gender of the user.
  
  Values are male, female, other, or unknown. Default value is unknown.
  
  dateOfBirth string(date)
  
  The date of birth of the user.
  
  nugget object Required
  
  The nugget that has been completed
  
  Hide nugget attributes Show nugget attributes object
  
  nuggetId string(uuid) Required
  
  Nugget UUID.
  
  name string Required
  
  Name of the nugget
  
  diagnostic boolean Required
  
  Is a diagnostic nugget
  
  startDate string(date-time) Required
  
  endDate string(date-time) Required
  
  metrics object Required
  
  Score, completion and duration metrics
  
  Hide metrics attributes Show metrics attributes object
  
  questionsAnswered number Required
  
  Number of questions answered
  
  correctAnswers number Required
  
  Number of questions answered correctly
  
  pointsAchieved number Required
  
  Number of points achieved
  
  pointsPossible number Required
  
  Total number of points possible
  
  score number(float) Required
  
  Percentage value between 0 and 100 floating point value
  
  Minimum value is 0, maximum value is 100.
  
  completion number(float) Required
  
  Percentage value between 0 and 100 floating point value
  
  Minimum value is 0, maximum value is 100.
  
  duration string(duration) Required
  
  Duration in ISO 8601 duration format
  
  A study session for a nugget that contained no questions
  
  Hide attributes Show attributes
  
  studySessionId string Required
  
  Study Session UUID.
  
  kind string Required Discriminator
  
  Value is NON_GRADED.
  
  user object Required
  
  User that has completed the study session
  
  Hide user attributes Show user attributes object
  
  userId string(uuid) Required
  
  User UUID.
  
  username string Required
  
  The username of the user.
  
  upn string
  
  The Unique Pupil Number (UPN) of the user.
  
  externalId string
  
  Identifier from an external source
  
  fullName string Required
  
  The full name of the user.
  
  firstName string Required
  
  The first name of the user.
  
  middleName string
  
  The middle name of the user.
  
  lastName string Required
  
  The last name of the user.
  
  emails array[string(email)]
  
  A list of all email addresses associated with the user.
  
  gender string Required
  
  The gender of the user.
  
  Values are male, female, other, or unknown. Default value is unknown.
  
  dateOfBirth string(date)
  
  The date of birth of the user.
  
  nugget object Required
  
  The nugget that has been completed
  
  Hide nugget attributes Show nugget attributes object
  
  nuggetId string(uuid) Required
  
  Nugget UUID.
  
  name string Required
  
  Name of the nugget
  
  diagnostic boolean Required
  
  Is a diagnostic nugget
  
  startDate string(date-time) Required
  
  endDate string(date-time) Required
  
  metrics object Required
  
  Completion and duration metrics
  
  Hide metrics attributes Show metrics attributes object
  
  completion number(float) Required
  
  Percentage value between 0 and 100 floating point value
  
  Minimum value is 0, maximum value is 100.
  
  duration string(duration) Required
  
  Duration in ISO 8601 duration format
- pagination object Required
  
  Metadata for the current pagination position
  
  Hide pagination attributes Show pagination attributes object
  
  total integer(int32) Required
  
  The total number of items available.
  
  limit integer(int32) Required
  
  The maximum number of results to return per page.
  
  Minimum value is 1, maximum value is 100. Default value is 100.
  
  offset integer(int32) Required
  
  Indicates the starting position or index (offset)
  
  Default value is 0.
  
  previousCursor string(byte) | null Required
  
  The cursor for pagination. Encoded byte string used to navigate between pages.
  
  nextCursor string(byte) | null Required
  
  The cursor for pagination. Encoded byte string used to navigate between pages.
400

Invalid request.
401

Invalid authentication credentials
403

Not authorised to access this resource

GET /sessions/completed

curl \
 --request GET 'https://connect.century.tech/api/v1/sessions/completed' \
 --header "x-api-key: $API_KEY"

Response examples (200)

{
  "data": [
    {
      "kind": "GRADED",
      "user": {
        "upn": "Y89421121401A",
        "emails": [
          "john.doe@email.com"
        ],
        "gender": "male",
        "userId": "68f06c66-702a-4c26-b8c5-b6dc4f81f25d",
        "fullName": "John Doe",
        "lastName": "Doe",
        "username": "john_doe",
        "firstName": "John",
        "externalId": "External_ID_123",
        "dateOfBirth": "2010-07-01"
      },
      "nugget": {
        "name": "Addition [MF1.01]",
        "nuggetId": "bc5f8904-c844-4c8a-8231-872e5c84dc8b",
        "diagnostic": false
      },
      "endDate": "2024-23-06T12:08:48.578Z",
      "metrics": {
        "score": 54.16666667,
        "duration": "PT3M25S",
        "completion": 90,
        "correctAnswers": 13,
        "pointsAchieved": 13,
        "pointsPossible": 24,
        "questionsAnswered": 24
      },
      "startDate": "2024-23-06T12:05:23.456Z",
      "studySessionId": "67bf476e17ed9cccd58c1fb4"
    }
  ],
  "pagination": {
    "limit": 100,
    "total": 1,
    "offset": 0,
    "nextCursor": null,
    "previousCursor": null
  }
}

{
  "data": [
    {
      "kind": "NON_GRADED",
      "user": {
        "upn": "Y89421121401A",
        "emails": [
          "john.doe@email.com"
        ],
        "gender": "male",
        "userId": "68f06c66-702a-4c26-b8c5-b6dc4f81f25d",
        "fullName": "John Doe",
        "lastName": "Doe",
        "username": "john_doe",
        "firstName": "John",
        "externalId": "External_ID_123",
        "dateOfBirth": "2010-07-01"
      },
      "nugget": {
        "name": "Addition [MF1.01]",
        "nuggetId": "bc5f8904-c844-4c8a-8231-872e5c84dc8b",
        "diagnostic": false
      },
      "endDate": "2024-23-06T12:08:48.578Z",
      "metrics": {
        "duration": "PT3M25S",
        "completion": 90.456
      },
      "startDate": "2024-23-06T12:05:23.456Z",
      "studySessionId": "67bf476e17ed9cccd58c1fb4"
    }
  ],
  "pagination": {
    "limit": 100,
    "total": 1,
    "offset": 0,
    "nextCursor": null,
    "previousCursor": null
  }
}