Generated by API Evangelist
Written by API Evangelist tooling for Canvas's API. It is a proposal applied on top of the contract, not a document Canvas publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Canvas LMS REST Quiz Submission Events API
version: 1.0.0
extends: openapi/canvas-quiz-submission-events-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 2
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/events'].get
update:
x-apievangelist-phrasing:
intent: Get events captured during a quiz attempt
effect: read
questions:
- What did a student do while taking a quiz, like page blurs or answer changes?
- Can I see the captured events for a specific attempt?
instructions:
- text: Get captured events for submission {id} on quiz {quiz_id} in course {course_id}.
slots:
id: path.id
quiz_id: path.quiz_id
course_id: path.course_id
- text: Show events from attempt {attempt} of submission {id}, quiz {quiz_id}, course {course_id}.
slots:
attempt: query.attempt
id: path.id
quiz_id: path.quiz_id
course_id: path.course_id
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/events'].post
update:
x-apievangelist-phrasing:
intent: Record events from a quiz session
effect: write
questions:
- How do I send the events captured during a quiz-taking session?
- Can a client store quiz-taking activity for a submission?
instructions:
- text: Submit events {quiz_submission_events} for submission {id} on quiz {quiz_id} in course {course_id}.
slots:
quiz_submission_events: requestBody.quiz_submission_events
id: path.id
quiz_id: path.quiz_id
course_id: path.course_id
- text: 'Store this quiz session activity for submission {id}, quiz {quiz_id}, course {course_id}: {quiz_submission_events}'
slots:
id: path.id
quiz_id: path.quiz_id
course_id: path.course_id
quiz_submission_events: requestBody.quiz_submission_events
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.