Use Cases

You can use the Read API to return reviews, questions, and answers left for your products by your customers. This is helpful espectially if you're using customizations on your website, have a mobile app where you want review content to appear, or if you want to integrate and feed review data into third-party software. You can retrieve this information by making GET calls to the Read API.

Read Services uses the read_services key.

Top Reviews Widget

You can use the Read API to return a certain amount of the highest rated reviews for a product. Retrieving the top "x" amount of highest rated reviews from the Read Services API can be achieved by using the "sort" and "paging.size" parameters. The sort parameter also allows sorting by LowestRating, HighestRating, MostHelpful, Oldest, Newest for reviews. For the following endpoint example, the top five highest ratings will be returned:

https://readservices-b2c.powerreviews.com/m/512774/l/en_US/product/7751057291/reviews?apikey=ec8f9acb-be0e-489b-a6ff-3eed3811025e&sort=HighestRating&paging.size=5

For More information, see further documentation.

Customer Relationship Management (CRM) Integration

You can use the Read API to ingest review content into your Customer Relationship Management (CRM) solution by the time it was last updated. For example, you can use the following endpoint to retrieve all of the published review content that has been updated from January 1, 2019 in batches of 10.

First Page: 

https://readservices-b2c.powerreviews.com/m/512774/reviews?apikey=ec8f9acb-be0e-489b-a6ff-3eed3811025e&date=1546322400000&updated_date_query=true&paging.size=25

Second Page: 

https://readservices-b2c.powerreviews.com/m/512774/reviews?apikey=ec8f9acb-be0e-489b-a6ff-3eed3811025e&date=1546322400000&updated_date_query=true&paging.size=10&paging.from=10

Third Page: 

https://readservices-b2c.powerreviews.com/m/512774/reviews?apikey=ec8f9acb-be0e-489b-a6ff-3eed3811025e&date=1546322400000&updated_date_query=true&paging.size=10&paging.from=20

The value for paging.size must be from 1 to 25, and the sum of the values for "paging.size" and "paging.from" cannot exceed 10,000. Going over either of these limits will return an error from the API.

For more information, see further documentation.

Read API Rate Limiting

On November 4, 2019, PowerReviews implemented "rate limiting" on our read API. If our API receives over 1800 calls from a single IP address within a 5 minute period, that IP address is blocked for a 5 minute period, until reassessment occurs. Should the excessive traffic continue, we will continue to block the IP address until the calls fall below the configured threshold.

To mitigate this, and to encourage faster and more efficient page loading, we highly recommend caching our API response, as opposed to calling it with each page load.

If you have any questions or run into any issues, please reach out to PowerReviews Technical Services.