Skip to navigation

Get Learning Quiz Results Report

Learning report: results of the class quizzes, one row per user, course and quiz.

Covers the quizzes attached to a class (video), not the final evaluation of the course, which /reports/learning/quizzes/ already reports. Attempts are consolidated: attempts_count, the dates of the first, last and best attempt, the score of the last attempt (score) and the highest one (best_score). Correct and incorrect answers, duration and status belong to the last attempt. Rows come ordered by last_attempt_at, newest first; page through them with cursor / next_cursor.

Authentication

Api-Keystring

API key of the organization. Always sent together with the Secret-Access header.

Path parameters

organization_slugstringRequired

Headers

Secret-AccessstringRequired

Query parameters

course_idlist of integersOptional

Learning course ids to filter by. Repeat the parameter for several courses (course_id=1&course_id=2), up to 100. A course that does not belong to the organization simply matches no row.

user_emailstringOptional
Exact match on the user email.
documentstringOptional

Exact match on the identity document loaded in the organization (user_document). Organizations that keep no documents match no row.

statusenumOptional
Status of the last attempt.
Allowed values:
from_datestringOptional

Start of the range, in YYYY-MM-DD format. Inclusive. With no to_date the range stays open going forward. Applies to the date of the last attempt of the class quiz (last_attempt_at), interpreted in UTC — the same zone the report returns that field in.

to_datestringOptional

End of the range, in YYYY-MM-DD format. Inclusive: the whole day is covered, not just its midnight. For a single day, send the same date in from_date and in to_date. Applies to the date of the last attempt of the class quiz (last_attempt_at), interpreted in UTC — the same zone the report returns that field in.

limitintegerOptional1-500Defaults to 100
Rows per page, up to 500. Defaults to 100 when omitted.
cursorstringOptional

Cursor for the next page. Take it from next_cursor in the previous response and send it back unchanged; it is opaque. Omit it for the first page.

Response

Successful Response
resultslist of objects
totalintegerOptional
Rows matching the filters, ignoring pagination.
next_cursorstringOptional

Cursor of the next page. Send it back unchanged in cursor; null on the last page.

has_next_pagebooleanOptionalDefaults to false
Whether there is a page after this one.

Errors

400
Bad Request Error
422
Unprocessable Entity Error