Skip to content

ulams quiz-attempts

Generated from front/cli (ulams schema)

Export course quiz results to an XLSX or XLS file.

Kind: read (idempotent). Stability: stable. MCP tool: quiz_attempts_export. Scopes: reports:read.

Endpoints: GET /api/admin/quiz-attempts/export.

Flag Type Required Description
--course-id integer yes
--topic-gift-quiz-id integer
--format string Output spreadsheet format. Defaults to xlsx.
--out string Write the download to this path (- for stdout)
Terminal window
# Export course quiz results to an XLSX or XLS file
ulams quiz-attempts export --course-id text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"course_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"topic_gift_quiz_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"format": {
"type": "string",
"enum": [
"xlsx",
"xls"
],
"description": "Output spreadsheet format. Defaults to xlsx."
},
"out": {
"description": "Write the download to this path (- for stdout)",
"type": "string"
}
},
"required": [
"course_id"
],
"additionalProperties": {}
}

Add, edit or remove tutor feedback for a quiz attempt.

Kind: write. Stability: stable. MCP tool: quiz_attempts_feedback. Scopes: reports:write.

Endpoints: PATCH /api/admin/quiz-attempts/{id}/feedback.

Flag Type Required Description
--id (positional) integer yes
--feedback string Tutor feedback (light rich text or video link). Send null or empty to remove it.
Terminal window
# Add, edit or remove tutor feedback for a quiz attempt
ulams quiz-attempts feedback 1 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"feedback": {
"type": "string",
"description": "Tutor feedback (light rich text or video link). Send null or empty to remove it."
}
},
"required": [
"id"
],
"additionalProperties": {}
}

Get quiz attempt by id.

Kind: read (idempotent). Stability: stable. MCP tool: quiz_attempts_get. Scopes: reports:read.

Endpoints: GET /api/admin/quiz-attempts/{id}.

Flag Type Required Description
--id (positional) integer yes
Terminal window
# Get quiz attempt by id
ulams quiz-attempts get 1 --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"id"
],
"additionalProperties": {}
}

Get all quiz attempts.

Kind: read (idempotent). Stability: stable. MCP tool: quiz_attempts_list. Scopes: reports:read.

Endpoints: GET /api/admin/quiz-attempts.

Flag Type Required Description
--page integer
--per-page integer
--topic-gift-quiz-id number
--course-id number
--user-id number
Terminal window
# Get all quiz attempts
ulams quiz-attempts list --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"per_page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"topic_gift_quiz_id": {
"type": "number"
},
"course_id": {
"type": "number"
},
"user_id": {
"type": "number"
}
},
"additionalProperties": {}
}