Developers
Exams

List exams

GET/products/{product_id}/exams

Returns the exams of the product. Requires the exams.read permission.

The collection never includes the correct alternatives; use the answer key operation, which requires the exams.read_answer_key permission.

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

Query Parameters

limit?integer
Range1 <= value <= 200
cursor?string
sort?string

Value in

  • "id"
  • "-id"
lesson_id?string

Public ID of a lesson. Returns only the exam displayed by that lesson.

deleted?boolean

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

application/json

application/json

curl -X GET "https://example.com/products/string/exams"
{  "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"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Exams

Exams in API v3: list exams, create an exam, retrieve an exam, update an exam, delete an exam, retrieve an exam answer key, list exam attempts, retrieve an exam attempt, reopen an exam attempt, retrieve the answers for an exam attempt, list exam questions, create an exam question, reorder exam questions, retrieve an exam question, update an exam question, delete an exam question, list exam results, retrieve an exam result, delete an exam result.

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.