The PowerReviews API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Getting Started
1. Create API credentials
To access the Enterprise API, you will first need to create your API credentials in Portal. You will need the client ID and client secret to access the API:
client_id: Your application's client ID
client_secret: Private identifier required for accessing data
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
2. Authenticate and get the access token
To request an access token, you will need to query the /oauth2 endpoint.
Base URL: https://enterprise-api.powerreviews.com
Use your client_id and client_secret keys from step 1:
If authentication is successful, you will receive this response:
3. Get review content
Your application must send an OAuth2 access token in an Authorization header with each request. Use the token from step 2 to get review content from the /reviews endpoint.
The /reviews The endpoint will provide you with a list of all your reviews, including pending, approved, and rejected content. You can ingest the content incrementally using the "updated_date" parameter.
Successful response:
Now that you know the basics of using the API, you might want to check out the API Reference for more details.
Pagination
| Parameter |
Description |
|
optional |
Number of results per call. Accepted values: 1 - 100. Default 100 |
|
optional |
A cursor for use in pagination.
is an ID that defines the beginning of the next page in the stream. |
Timestamps
Timestamps are expressed in Unix Time (milliseconds since Epoch, Jan 1, 1970, midnight UTC+0)
created_date: timestamp when the review was submitted
updated_date: timestamp for publication changes, i.e., a review was updated to 'approved' from 'pending' publication status.
Versioning
PowerReviews API is versioned to give you the latest features while also safely ensuring your apps don't break when we launch changes.
Status codes
- 200 OK Successful request
- 202 The request has been accepted for processing, but the processing has not been completed
- 400 Bad Request Returns JSON with the error message
- 401 Unauthorized Couldn’t authenticate your request
- 402 2FA Token required Re-try request with user’s 2FA token as CB-2FA-Token header
- 403 Invalid scope User hasn’t authorized necessary scope
- 404 Not Found No such object
- 500 Internal Server Error Something went wrong
- 503 Service Unavailable Your connection is being throttled or the service is down for maintenance
- 504 Gateway Timeout server error
API Rate Limits
To improve the experience for all our users, we impose limits on API requests. Users who send many requests in quick succession may see error responses that show up as status code 429.
- Max requests per second: 10
- 429 HTTP Code Response
