Skip to content

Read quiz attempt

Reads one of the customer's quiz attempts to review: its questions, the answers given and, once graded, each result with the key where the quiz shows it.

Needs the read scope.

Call

  • Tool: get_attempt
  • Scope: read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
product object Yes
attempt object Yes
preview string No A token a seller made for the quiz’s product’s page, which opens the quiz of a published entry of the product unpublished, or for the quiz’s entry, which opens it unpublished too, gated as ever; with it, a sitting on any quiz it does not open is not_found preview.
{
  "type": "object",
  "properties": {
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "attempt": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "preview": {
      "description": "A token a seller made for the quiz's product's page, which opens the quiz of a published entry of the product unpublished, or for the quiz's entry, which opens it unpublished too, gated as ever; with it, a sitting on any quiz it does not open is `not_found` `preview`.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": [
    "product",
    "attempt"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
attempt object Yes
questions array of object Yes
attachments array of object Yes
files object Yes
answers object Yes
results array of object or null Yes

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close