Developers
Exams

Retrieve an exam

GET/products/{product_id}/exams/{exam_id}

Retrieves an exam by its public ID. The response never includes the correct alternatives; use the answer key operation, which requires the exams.read_answer_key permission.

The response includes an ETag representing the current revision. Send this value in the If-Match header when modifying the exam to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string
exam_id*string

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/products/string/exams/string"
{  "data": {    "attempts_count": 0,    "created_at": "2019-08-24T14:15:22Z",    "deleted": true,    "description": "string",    "id": "string",    "lesson_ids": [      "string"    ],    "object": "exam",    "product_id": "string",    "questions_count": 0,    "revision": "string",    "settings": {      "duration_minutes": 0,      "min_grade": 0,      "questions_count": 0,      "retake": {        "allowed": true,        "only_if_failed": true,        "wait_minutes": 0      },      "show_answer_key": {        "approved": true,        "failed": true      },      "show_answers": true,      "show_grade": true,      "shuffle_alternatives": true,      "shuffle_questions": true    },    "title": "string",    "updated_at": "2019-08-24T14:15:22Z"  }}

Create an exam POST

Creates an exam in the product. A new exam is not attached to any lesson. To display it to users, set its ID in the `exam_id` field of a lesson using the lesson update operation.

Update an exam PATCH

Updates an exam. `settings` is applied partially: omitted keys keep their current values, and `null` in a numeric setting removes the limit. To avoid overwriting a newer version, send the `ETag` from the retrieve operation in the `If-Match` header.