List Classification Test Results
This endpoint allows querying the results of a classification test in a specific course in Toolzz LMS.
Request Example
Section titled “Request Example”curl --request GET \ --url 'https://kong.api.toolzz.com.br/api/content/classification/{test_name}?course_id={course_id}' \ --header 'Authorization: Bearer <token>'Response Example
Section titled “Response Example”{ "status": 200, "data": [ { "id": 123, "nome": "<string>", "email": "<string>", "tentativas": [ { "content_try_id": 1, "content_id": 2, "course_id": 456, "score": 90, "classification": "<string>", "try": 1, "created_at": "<string>" } ] } ]}Request description
Section titled “Request description”Access Token
Section titled “Access Token”| Parameter | Type | Description | Required |
|---|---|---|---|
Authorization | String | Access token (“Bearer” must be before the token) | Yes |
URL Parameters (Path)
Section titled “URL Parameters (Path)”| Parameter | Type | Description | Required |
|---|---|---|---|
test_name | string | Name of the assessment that will be used for classification. | Yes |
URL Parameters (Query)
Section titled “URL Parameters (Query)”| Parameter | Type | Description | Required |
|---|---|---|---|
course_id | int | ID of the course for which the results will be queried. | Yes |
Note: To use this resource, it is necessary to have the “Classification Tests” feature active on the platform.
Response description
Section titled “Response description”| Key | Type | Description |
|---|---|---|
status | number | Response status code. |
data | array | List of users and their results. |
data.id | number | Unique user identifier. |
data.nome | string | User name. |
data.email | string | User email. |
data.tentativas | array | List of user attempts. |
data.tentativas.content_try_id | number | Unique identifier of the content attempt. |
data.tentativas.content_id | number | Unique identifier of the content. |
data.tentativas.course_id | number | Course identifier related to the attempt. |
data.tentativas.score | number | Score obtained in the attempt. |
data.tentativas.classification | string | Classification based on the score. |
data.tentativas.try | number | Attempt number. |
data.tentativas.created_at | Date | Attempt creation date. |
Security
Section titled “Security”To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.