Skip to content

Get review statistics

GET
/stores/{storeRef}/reviews/stats
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/reviews/stats \
--header 'x-api-key: <x-api-key>'

Returns how many reviews the store has in each moderation status, how many have a reply, the average rating of approved reviews and the share of reviews that have a reply.

Required scopes: read:reviews

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
total
required

Number of reviews, deleted ones excluded.

number
pending
required

Number of PENDING reviews.

number
approved
required

Number of APPROVED reviews.

number
rejected
required

Number of REJECTED reviews.

number
hidden
required

Number of HIDDEN reviews.

number
replied
required

Number of reviews that have at least one reply.

number
average_rating
required

Average rating of approved reviews, rounded to one decimal. 0 when there are none.

number
response_rate
required

Share of reviews that have a reply, as a percentage from 0 to 100.

number

Example generated

{
"total": 1,
"pending": 1,
"approved": 1,
"rejected": 1,
"hidden": 1,
"replied": 1,
"average_rating": 1,
"response_rate": 1
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}