Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Quiz Statistics API

2 actions 2 updates phrasing extends openapi/canvas-quiz-statistics-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/statistics'].get

OpenAPI Overlay

# 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 Statistics API
  version: 1.0.0
extends: openapi/canvas-quiz-statistics-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: 1
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for a quiz
      effect: read
      questions:
      - How did my students do on a quiz overall and per question?
      - Can I get quiz statistics across all versions of a quiz instead of just the latest?
      instructions:
      - text: Get the latest statistics for quiz {quiz_id} in course {course_id}.
        slots:
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: Show quiz {quiz_id} stats in course {course_id} with all versions set to {all_versions}.
        slots:
          quiz_id: path.quiz_id
          course_id: path.course_id
          all_versions: query.all_versions
      method: generated
      generated: '2026-10-01'