Query parameters

• startDate object

  Filter the results by session start date

  Supports either a ISO 8601 formatted date or a Unix timestamp. For example startDate[gt]=1688200245 or startDate[lt]=2023-07-15T12:00:00.000Z

  The following operators cannot be used together

  • gt and gte
  • lt and lte
  Hide startDate attributes Show startDate attributes object

  • gt string(date-time) | integer(int32)

    One of:

    ISO 8601 DateTime string(date-time) Unix Timestamp integer(int32)

  • gte string(date-time) | integer(int32)

    One of:

    ISO 8601 DateTime string(date-time) Unix Timestamp integer(int32)

  • lt string(date-time) | integer(int32)

    One of:

    ISO 8601 DateTime string(date-time) Unix Timestamp integer(int32)

  • lte string(date-time) | integer(int32)

    One of:

    ISO 8601 DateTime string(date-time) Unix Timestamp integer(int32)
• userId array[string(uuid)]

  Filter the results by user ID.

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

  This parameter supports a maximum of 30 identifiers.

  At least 1 but not more than 30 elements.

• testId array[string(uuid)]

  Filter the results by test ID.

  Multiple identifiers can be specified by repeating the query parameter. e.g. testId=id1&testId=id2

  This parameter supports a maximum of 30 identifiers.

  At least 1 but not more than 30 elements.

• subject array[string]

  Filter the results by test subject.

  Multiple identifiers can be specified by repeating the query parameter. e.g. subject=sub1&subject=sub2

  This parameter supports a maximum of 30 identifiers.

  At least 1 but not more than 30 elements.

• limit integer(int32)

  Specify the pagination limit, defaults to 100

  Minimum value is 1, maximum value is 100. Default value is 100.

• offset integer(int32)

  Specify the pagination offset, defaults to 0.

  Cannot be used with cursor

  Default value is 0.

• cursor string(byte) | null

  Provide the next or previous page cursor

• sort object

  Specify the sort order of the results.

  The default sort order is sort[field]=startDate&sort[direction]=asc

  Hide sort attributes Show sort attributes object

  • field string

    The available sort fields.

    Values are startDate or endDate.

  • direction string

    The sort direction used for ordering the results. Can be "asc" (ascending) or "desc" (descending).

    Values are asc or desc.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • data array[object] Required
    Hide data attributes Show data attributes object

    • sessionId string(uuid) Required

      The unique identifier for the Smart IA session (UUID).

    • startDate string(date-time) Required

      The start date and time of the Smart IA session.

    • status string Required

      The status of the Smart IA session, for in progress sessions this will always be "IN_PROGRESS".

      Value is IN_PROGRESS.

    • user object Required

      Information about the the Smart IA session user.

      Hide user attributes Show user attributes object

      • userId string(uuid) Required

        The unique identifier for the user (UUID).

      • username string Required

        The username of the user.

      • upn string

        The Unique Pupil Number (UPN) of the user.

      • externalId string

        External user identifier provided during onboarding or signup

      • 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.

    • test object Required

      Information about the the Smart IA session test.

      Hide test attributes Show test attributes object

      • testId string(uuid) Required

        The unique identifier for the Smart IA test (UUID).

      • testVersionId string(uuid) Required

        The unique identifier for the Smart IA test version (UUID).

      • name string Required

        The name of the Smart IA test.

      • subject string Required

        The subject of the Smart IA test.

  • pagination object Required
    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.

• 401

  Invalid authentication credentials

• 403

  Not authorised to access this resource