Skip to content
Navigation

Starts an attempt at a quiz, or resumes the open one, until the quiz is over: given up, its attempts used, or one attempt scored 100.

POST
https://api.sherpo.io/customer/v1/stores/{store}/products/{product}/entries/{entry}/quizzes/{quiz}/attempts

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1
  • entry
    string
    required
    minLength: 1
  • quiz
    string
    required
    minLength: 1

Request body JSON optional

  • preview
    optional
    string

    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, any quiz it does not open is not_found preview.

    maxLength: 128 · minLength: 1

Returns

200

Starts an attempt at a quiz, or resumes the open one, until the quiz is over: given up, its attempts used, or one attempt scored 100.

JSON
  • attempt
    object
    required
    • id
      string
      required
    • product_id
      string
      required
    • quiz_id
      string
      required
    • entry_id
      string
      required
    • attempt
      number
      required
    • status
      string
      required
    • score
      required

      One of the following:

      • number
      • null
    • correct
      required

      One of the following:

      • number
      • null
    • started_at
      string
      required
    • finished_at
      required

      One of the following:

      • string
      • null
    • access
      string
      required
  • questions
    array of
    object
    required
    • type
      string
      required
    • id
      string
      required
    • question
      required

      One of the following:

      • string
      • null
    • content
      required

      A static text's text, in the rich text format as stored.

      One of the following:

      • string
      • null
    • options
      required

      One of the following:

      • array<object>
      • null
    • min
      required

      One of the following:

      • number
      • null
    • max
      required

      One of the following:

      • number
      • null
    • weight
      required

      One of the following:

      • number
      • null
    • hint
      required

      One of the following:

      • string
      • null
  • attachments
    array of
    object
    required
    • tracks
      array of
      object
      required
      • id
        string
        required
      • label
        required

        One of the following:

        • string
        • null
      • language
        required

        One of the following:

        • string
        • null
      • generated
        boolean
        required

        Subtitles the store generated with AI from the video's audio.

    • outputs
      array of
      string
      required

      The published AI outputs getMediaOutputs reads beside the video or audio file.

    • access
      string
      required
    • id
      string
      required
    • role
      string
      required
    • delivery
      string
      required
    • preview_only
      boolean
      required
    • from_body
      boolean
      required

      Named by its target's body text, rather than the target's own media (a lesson's video or slides).

    • position
      number
      required
    • asset
      object
      required
      • id
        string
        required
      • name
        required

        One of the following:

        • string
        • null
      • title
        required

        One of the following:

        • string
        • null
      • ext
        required

        One of the following:

        • string
        • null
      • description
        required

        One of the following:

        • string
        • null
      • mime
        required

        One of the following:

        • string
        • null
      • bytes
        required

        The file's size in bytes, null when it has none or is withheld.

        One of the following:

        • number
        • null
      • enforcement
        string
        required
      • locator
        required

        One of the following:

        • string
        • null
      • metadata
        object
        required
        • width
          required

          One of the following:

          • number
          • null
        • height
          required

          One of the following:

          • number
          • null
        • duration
          required

          One of the following:

          • number
          • null
        • pages
          required

          One of the following:

          • number
          • null
      • status
        string
        required
  • files
    map of
    object
    required
  • answers
    map of
    any of
    required
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close