Skip to content

List quiz attempts

Pages the customer's quiz attempts.

Needs the read scope.

Pages its answer: pass the cursor back for the next page, at most 100 items a page.

Filters: entry_id (eq), quiz_id (eq), status (eq, in).

Sorts: started.

Call

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

Arguments

Name Type Required Description
product object No Only the sittings on this product’s quizzes.
query object No
{
  "type": "object",
  "properties": {
    "product": {
      "description": "Only the sittings on this product's quizzes.",
      "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
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {
        "filter": {
          "type": "object",
          "properties": {
            "entry_id": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "object",
                  "properties": {
                    "eq": {
                      "type": "string"
                    }
                  },
                  "minProperties": 1,
                  "additionalProperties": false
                }
              ]
            },
            "quiz_id": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "object",
                  "properties": {
                    "eq": {
                      "type": "string"
                    }
                  },
                  "minProperties": 1,
                  "additionalProperties": false
                }
              ]
            },
            "status": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "started",
                    "passed",
                    "failed",
                    "forfeited"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "eq": {
                      "type": "string",
                      "enum": [
                        "started",
                        "passed",
                        "failed",
                        "forfeited"
                      ]
                    },
                    "in": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "enum": [
                          "started",
                          "passed",
                          "failed",
                          "forfeited"
                        ]
                      },
                      "minItems": 1,
                      "maxItems": 50
                    }
                  },
                  "minProperties": 1,
                  "additionalProperties": false
                }
              ]
            }
          },
          "additionalProperties": false
        },
        "sort": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "enum": [
                "started"
              ]
            },
            "direction": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            }
          },
          "additionalProperties": false
        },
        "limit": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100
        },
        "cursor": {
          "type": "string",
          "maxLength": 8192
        },
        "count": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Answer

Name Type Required Description
items array of object Yes
cursor string or null Yes
total number No
facets object No

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

Type to search…

↑↓ navigate↵ selectEsc close