Skip to content
Navigation

Reads review counts and ratings.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Returns

200

Reads review counts and ratings.

JSON
  • products
    number
    required
  • summary
    required

    One of the following:

    • string
    • null
  • topics
    array of
    object
    required
    • topic
      string
      required
    • positive
      number
      required
    • negative
      number
      required
  • hidden
    number
    required
  • count
    number
    required
  • average
    required

    One of the following:

    • number
    • null
  • histogram
    object
    required
    • 1
      number
      required
    • 2
      number
      required
    • 3
      number
      required
    • 4
      number
      required
    • 5
      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