Skip to content
Navigation

Reads one quiz attempt with its answers.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/attempts/{attempt}

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1
  • attempt
    string
    required
    minLength: 1

Returns

200

Reads one quiz attempt with its answers.

JSON
  • customer
    required

    One of the following:

    • object
    • null
  • quiz
    object
    required
    • body
      object
      required
      • attachment_id
        string
        required
      • asset_id
        string
        required
      • title
        required

        One of the following:

        • string
        • null
      • blocks
        array of
        object
        required
        • type
          string
          required
        • id
          string
          required
    • question_count
      number
      required

      How many of its blocks are questions a sitter answers.

    • files
      map of
      object
      required
    • sittings
      number
      required
    • certificates
      array of
      object
      required
      • id
        string
        required
      • product_id
        string
        required
      • quiz_id
        required

        One of the following:

        • string
        • null
      • headline_copy
        string
        required
      • title_copy
        required

        One of the following:

        • string
        • null
      • awarded_copy
        required

        One of the following:

        • string
        • null
      • reason_copy
        required

        One of the following:

        • string
        • null
      • score_copy
        required

        One of the following:

        • string
        • null
      • out_of_score_copy
        required

        One of the following:

        • string
        • null
      • settings
        object
        required
        • template
          string
          required
        • accent
          required

          One of the following:

          • string
          • null
        • requires_passing
          optional
          boolean

          Earned by passing the quiz, not by merely finishing it.

        • earned_on
          optional
          string

          Set on a certificate no quiz awards: finishing every entry of a course, or a check-in at an event, earns it; losing its quiz never makes one.

        • shows
          optional
          array of
          string
      • created_at
        required

        One of the following:

        • string
        • null
    • id
      string
      required
    • entry_id
      string
      required
    • product_id
      string
      required
    • version
      number
      required
    • settings
      object
      required
      • attempts_allowed
        required

        One of the following:

        • number
        • null
      • pass_mark
        required

        One of the following:

        • number
        • null
      • show_answers
        boolean
        required
    • created_at
      required

      One of the following:

      • string
      • null
    • updated_at
      required

      One of the following:

      • string
      • null
  • id
    string
    required
  • product_id
    string
    required
  • quiz_id
    string
    required
  • customer_id
    string
    required
  • attempt
    number
    required
  • status
    string
    required
  • answers
    map of
    object
    required
  • score
    required

    One of the following:

    • number
    • null
  • correct
    required

    One of the following:

    • number
    • null
  • started_at
    required

    One of the following:

    • string
    • null
  • finished_at
    required

    One of the following:

    • string
    • null
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