Get review statistics
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/reviews/stats';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Responses
Section titled “Responses”object
Number of reviews, deleted ones excluded.
Number of PENDING reviews.
Number of APPROVED reviews.
Number of REJECTED reviews.
Number of HIDDEN reviews.
Number of reviews that have at least one reply.
Average rating of approved reviews, rounded to one decimal. 0 when there are none.
Share of reviews that have a reply, as a percentage from 0 to 100.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}