Retrieve Review Summary
An API to summarize and generate AI based review highlights for a product.
Consumer satisfaction with a purchase is closely tied to having an easy buying process with clear, tailored product information. Catering to rising consumer requirement for a product's summarization, the Review Summarization API was hence developed.
The Review Summarization API is a featured product part of the Conversations API. The access is limited to clients on Advanced and Enterprise packages. To know more on how to gain access, clients should reach out to their respective Account Managers or the Support Community.
Example API Call - Review Summarization
The Review Summarization API has only one endpoint, focused on retrieving the AI processed product summaries extracted from the pool of reviews for a particular product.
The Review Summarization API uses the Conversations API passkey for authentication.
No summary will be generated for products with less than 30 English language reviews.
curl --request GET \
--url 'https://api.bazaarvoice.com/reviewsummary?productId=PRODUCT_ID&clientId=CLIENT_INSTANCE&formatType=paragraph' \
--header 'accept: application/json' \
--header 'passkey: ConversationsAPI_Passkey'
Sample Response
{
"summary": "This outdoor jacket receives enthusiastic reviews for its versatile design and performance features. Users praise its lightweight, breathable fabric and water-resistant properties. The fit accommodates various body types comfortably. Reviewers appreciate its functionality for different activities and climates. Many highlight the stylish look and durability after repeated use. Customers find it great value and often purchase multiple colors. Overall, users highly recommend this jacket for its blend of style, comfort, and practicality.",
"status": 200,
"type": "TEXT",
"title": "REVIEW_SUMMARY",
"detail": "PARAGRAPH_SUMMARY",
"disclaimer": "This summary is generated by artificial intelligence based on customer reviews"
}
The summaries are up to 100 words in length. There are two formats available to chose from: a
paragraphformatted summary; and abulletpoint formatted summary.
Headers
The API requires the Conversations API passkey for Authorization.
| Name | Description | Required |
|---|---|---|
passkey | Authorization header. Please use the Conversations API passkey for the respective client instance to successfully authenticate. | YES ✅ |
Parameters
The API currently supports the following parameters for queries.
| Name | Description | Required |
|---|---|---|
productId | Use the product id as saved in the bazaarvoice product catalog for the client instance. Note: Using incorrect product ID would yield an empty response. | YES ✅ |
| clientId | Bazaarvoice client instance name as registered in the Bazaarvoice Portal. If not passed, the API returns result for the client instance associated with the API Passkey passed in the header. | NO |
formatType | This field allows you to choose between the two available formats - bullet and paragraph. If not passed, the default format will be Paragraph Summary. | NO |
Errors and Responses
Please refer to the below table for expected errors and Responses.
| Status | Description |
|---|---|
200 ; ✅ Correct API query with a valid Product ID | Returns a successful API response with Review summarization as a paragraph/bulleted summary. |
200 ; ❌ Incorrect API query/Wrong Product ID or Review Summarization not enabled for a client instance | Returns an API response with empty fields/No Data Found. |
400 | Bad Request. Request is missing required parameters. |
401 | Incorrect/Invalid authentication credentials used. |
403 | Credentials (Passkey) lack permission to access the API endpoint. |
500 | Internal Server Error. Unexpected error found in resolving the API request. |
Please refer to the Review Summarization API Reference.
For support on questions regarding the API, please refer to the FAQs.
Updated 12 days ago