PaginatedSessionsOutput

Paginated list of sessions

  • limit
    Type: integer
    required

    Maximum number of items returned

  • offset
    Type: integer
    required

    Number of items skipped in the result set

  • sessions
    Type: array object[] ยท SessionOutput[]
    required

    Array of session objects

    Session information

    • applicationId
      Type: stringFormat: uuid
      required

      Identifier for the LTI application used in the session

    • durationInSeconds
      Type: integer
      required

      Total duration of the session in seconds

    • endedAtTime
      Type: stringFormat: date-time
      required

      Timestamp when the session ended

    • id
      Type: string
      required

      Session identifier

    • startedAtTime
      Type: stringFormat: date-time
      required

      Timestamp when the session started

    • toolId
      Type: stringFormat: uuid
      deprecated
      required

      Deprecated: Identifier for the LTI tool used in the session. Use applicationId instead.

    • wasteDurationInSeconds
      Type: integer
      required

      Total waste duration of the session in seconds

    • wastePercentage
      Type: integer
      required

      Percentage of session time that was waste (0-100)

    • isProctored
      Type: boolean

      Indicates whether this session is considered proctored

    • metadata
      Type: object | null

      Opaque session metadata object

    • proctoredResult
      Type: string

      Result of the proctored session

    • recordingEndedAtTime
      Type: string | nullFormat: date-time

      Timestamp when the recording ended

    • recordingS3Key
      Type: string | null

      S3 key for the associated proctoring recording, if any

    • recordingStartedAtTime
      Type: string | nullFormat: date-time

      Timestamp when the recording started

    • webcamEnabled
      Type: boolean

      Indicates whether the webcam was enabled for this session

  • total
    Type: integer
    required

    Total number of items available