Skip to content
Navigation

Reads a product's quiz results.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Query parameters

  • from
    optional
    string
    format: date
  • to
    optional
    string
    format: date
  • quiz
    optional
    string

    An id.

    minLength: 1

Returns

200

Reads a product's quiz results.

JSON
  • entries
    array of
    object
    required
    • total
      number
      required
    • by_status
      object
      required
      • started
        number
        required
      • submitted
        number
        required
      • passed
        number
        required
      • failed
        number
        required
      • forfeited
        number
        required
    • pass_rate
      required

      One of the following:

      • number
      • null
    • average_score
      required

      One of the following:

      • number
      • null
    • average_seconds
      required

      One of the following:

      • number
      • null
    • entry_id
      string
      required
  • total
    number
    required
  • by_status
    object
    required
    • started
      number
      required
    • submitted
      number
      required
    • passed
      number
      required
    • failed
      number
      required
    • forfeited
      number
      required
  • pass_rate
    required

    One of the following:

    • number
    • null
  • average_score
    required

    One of the following:

    • number
    • null
  • average_seconds
    required

    One of the following:

    • number
    • null
  • time_zone
    string
    required
  • from
    required

    One of the following:

    • string
    • null
  • to
    required

    One of the following:

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