Sign in
GameResult

Gets the Game Results

Changed on

Gets the Game Results that were asked for..? Filter available by session and student.

get/game-results

Request

  • Base URL: http://localhost:8080/api/v1
  • URL: http://localhost:8080/api/v1/game-results
  • Auth: none declared

Query parameters

session_idstring uuid

The SessionID of the session whose game results you seek

student_idstring uuid

The StudentID of the student whose game results you seek

category'receptive_language' | 'expressive_language' | 'social_pragmatic_language' | 'speech'

The category of the game results you seek

question_type'sequencing' | 'following_directions' | 'wh_questions' | 'true_false' | 'concepts_sorting' | 'fill_in_the_blank' | 'categorical_language' | 'emotions' | 'teamwork_talk' | 'express_excitement_interest' | 'fluency' | 'articulation_s' | 'articulation_l'

The question type of the game results you seek

difficulty_levelinteger

The difficulty level of the game results you seek

exercise_type'game' | 'pdf'

The exercise type of the game results you seek

game_type'drag and drop' | 'spinner' | 'word/image matching' | 'flashcards'

The game type of the game results you seek

date_fromstring date-time

Start date to filter game results (inclusive)

date_tostring date-time

End date to filter game results (inclusive)

pageinteger

Page Number of pagination

limitinteger

Number of Items per page in pagination

Response

The Game Results you requested

idstring uuid required

ID of the Game Result.

session_student_idstring uuid required

ID of the Student-Session associated with the Game.

content_idstring uuid required

ID of the Content of the Game

time_taken_secinteger required

Number of seconds it takes to complete the game

completedboolean required

Whether or not the game was completed or not

count_of_incorrect_attemptsinteger required

The number of incorrect attempts made during the game

incorrect_attemptsstring[] required

The actual incorrect answers chosen during the game

created_atstring date-time required

When the game-content was created

updated_atstring date-time required

When the game-content was last updated

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174946",
    "session_student_id": "123e4567-e89b-12d3-a456-426614174946",
    "content_id": "123e4567-e89b-12d3-a456-426614174cid",
    "time_taken_sec": 93,
    "completed": true,
    "count_of_incorrect_attempts": 1,
    "incorrect_attempts": [
      "Kroookodiley"
    ],
    "created_at": "2025-09-13T17:19:00Z",
    "updated_at": "2025-09-13T17:19:00Z"
  }
]

Changes

  • e4db8e207c51Revision changes
    • ○

      added the new optional query request parameter category

    • ○

      added the new optional query request parameter date_from

    • ○

      added the new optional query request parameter date_to

    • ○

      added the new optional query request parameter difficulty_level

    • ○

      added the new optional query request parameter exercise_type

    • ○

      added the new optional query request parameter game_type

    • ○

      added the new optional query request parameter question_type

  • 76438aec67ecRevision changes
    • ○

      endpoint added