The endpoint is primarily used to retrieve bottomline scores for each product.
These scores help track product feedback across different categories, allowing users to understand product performance from multiple review sources.
- Total Reviews and Scores - includes all review and sources from all sources.
- Total Organic Reviews and Scores - Includes reviews and scores from the domestic store alone (No syndication, No Shop Reviews)
- For example, you can use it to:
- Retrieve the bottom line (total reviews and average score) for all products;
- Total Reviews - Including all other sources
- Average Score - Including all other sources
- Total Organic Reviews (Domestic Store only reviews)
- Organic Average Score (Domestic Store only reviews)
- Pagination: The endpoint is limited to returning a maximum of 10 items per page, so multiple calls are needed to retrieve more data.
GET | https://api.yotpo.com/v3/storefront/stores/{storeId}/ratings?perPage=10&page=1
Path params
Param | Type | Description |
---|---|---|
storeId | String | The store ID (App Key) |
Results
{
"status": {
"code": 200,
"message": "OK"
},
"response": {
"page": 1,
"perPage": 10,
"bottomlines": [
{
"productId": "9283XXXXX1267",
"totalReviews": 0,
"averageScore": 0,
"totalOrganicReviews": 0,
"organicAverageScore": 0
},
{
"productId": "926XXXXX603",
"totalReviews": 0,
"averageScore": 0,
"totalOrganicReviews": 0,
"organicAverageScore": 0
},
{
"productId": "926XXXXXX931",
"totalReviews": 0,
"averageScore": 0,
"totalOrganicReviews": 0,
"organicAverageScore": 0
},
{
"productId": "918XXXXXXX55",
"totalReviews": 1,
"averageScore": 5,
"totalOrganicReviews": 0,
"organicAverageScore": 0
},
{
"productId": "88XXXXXXXX67",
"totalReviews": 1,
"averageScore": 5,
"totalOrganicReviews": 0,
"organicAverageScore": 0
},
{
"productId": "887XXXXXXXX83",
"totalReviews": 3,
"averageScore": 5,
"totalOrganicReviews": 0,
"organicAverageScore": 0
},
{
"productId": "88XXXXXXXXX5",
"totalReviews": 0,
"averageScore": 0,
"totalOrganicReviews": 0,
"organicAverageScore": 0
},
{
"productId": "8840XXXXXXXX587",
"totalReviews": 0,
"averageScore": 0,
"totalOrganicReviews": 0,
"organicAverageScore": 0
},
{
"productId": "884XXXXXXXX7",
"totalReviews": 2,
"averageScore": 5,
"totalOrganicReviews": 0,
"organicAverageScore": 0
},
{
"productId": "884XXXXXXXXX75",
"totalReviews": 117,
"averageScore": 4.6153846,
"totalOrganicReviews": 0,
"organicAverageScore": 0
}
]
}
}
How to use this endpoint
- Requests for this endpoint are limited to 30,000 requests/minute, per IP address.
- Data is retrieved with a delay of 3 hours.