🚧

Only API keys on our Conversations platform are eligible to use this API version. Refer to the Platforms section of our Platform & API Concepts documentation to learn which platform your API keys are on.

📘

Try out Comment Display API reference here.

Examples

The following examples demonstrate common Conversations API display requests. For a complete overview of using the Conversations API to display data, refer Display tutorials.

🚧

Demonstration purposes only. Do not reuse the API passkeys below in your application.

Requesting all comments for a particular review

This returns comments posted on the specified review.

https://stg.api.bazaarvoice.com/data/reviewcomments.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&filter=reviewid:16970457

Requesting a particular review comment

This returns specified comment posted on a review.

https://stg.api.bazaarvoice.com/data/reviewcomments.json?ApiVersion=5.4&PassKey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&Filter=Id:338201

Advanced comment request

This request illustrates using multiple filters (just add another &filter=[filter] section), requesting additional content (include=[content]), sorting (sort=[attribute]:[order]), limiting the result count and requesting the second page of results.

https://stg.api.bazaarvoice.com/data/reviewcomments.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&filter=productid:data-gen-3jxhm78sfqfy8tg5qyinqioal&include=authors,products,categories&sort=totalpositivefeedbackcount:desc&limit=4&offset=4

Multiple values can be provided in comma-separated form, such as the included content types of authors, reviews, products and categories related to the comments.

Requesting all native (non-syndicated) review comments

❗️

Native (non-syndicated) content only. Continue reading for more details.

https://stg.api.bazaarvoice.com/data/reviewcomments.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4

Requests for this content type that do not include a ProductId, AuthorId, CategoryAncestorId, SubmissionId, or Comment Id filter will only work with API keys that are configured to exclude syndicated content.

We recommend using our Displayable Content Export service to download all of your native and syndicated content. If you still prefer the Conversations API, then you may contact our support team to have your Conversations API keys re-configured.

Parameters

&filter=productid:eq:1101&excludeFamily=true

Filter options

• Each filter argument specifies the attribute to filter on followed by a comma-separated list of values. For instance, "Filter=TotalFeedbackCount:eq:3,4" will match all content with TotalFeedbackCount values equal to 3 OR 4.
• Advanced operators can be used to define filters. For instance, "Filter=TotalFeedbackCount:lte:10" will match all content with a rating value less than or equal to 10. All advanced operators are documented on the Conversations API page.
• If a filter value contains a comma or a colon, that character needs to be escaped with a backslash (, or :). If a filter value contains an ampersand (&), the ampersand must be encoded in the filter value by replacing & with %26.
• Multiple filters are allowed as URL parameters in which case filters are AND'ed. For instance, "Filter=TotalFeedbackCount:gt:10&Filter=IsFeatured:true" will match all featured content with a TotalFeedbackCount value of greater than 10.
• Time-based filters can be used for SubmissionTime, LastModificationTime and LastModeratedTime. Dates in time-based filters are calculated as the number of seconds since January 1, 1970, 00:00:00 UTC. In a future version, we will be adding support for comparing date/time string values. The following example returns content that was submitted on November 9, 2009: &filter=SubmissionTime:gt:1257746400&filter=SubmissionTime:lt:1257832800

The following table lists the attributes available for filtering.

Sort options

• Sort criteria is specified as :asc for ascending and :desc for descending
• Multi-attribute sorting is supported by using a comma separated list of sort criteria for a content/subject type. For instance Sort=TotalFeedbackCount:desc,TotalPositiveFeedbackCount:asc sorts by number of feedbacks received descending, then number of positive feedbacks received ascending

The following table lists the attributes that are available for sorting.

Response format

This is a sample response for requesting review comments. Use the links above
to see live examples.

{
    "Includes": { },
    "HasErrors": false,
    "Offset": 0,
    "TotalResults": 224775,
    "Locale": "en_US",
    "Errors": [ ],
    "Results": [
        {...}
        {...}
    ],
    "Limit": 2

}

Response elements

Error codes

🚧

By default, for all the form errors occurred during the API calls, the HTTPS response code 200 OK is returned, with the error information in the JSON response body.

curl --location 'https://stg.api.bazaarvoice.com/data/reviewcomments.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4k&Filter=ProductId%3Adata-gen-moppq9ekthfzbc6qff3bqokie&Include=Products'

If the clients wish to receive 4xx, 5xx kind of error codes in HTTPS response, a small addition needs to be made to the api call. In the request header of the API call, add "bv-version" with value "5.4.1", this will generate appropriate 4xx, 5xx error codes in the HTTPS response. The JSON response still contains the detailed description of the error.

Example curl with header:

curl --location 'https://stg.api.bazaarvoice.com/data/reviewcomments.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4k&Filter=ProductId%3Adata-gen-moppq9ekthfzbc6qff3bqokie&Include=Products' \
--header 'bv-version: 5.4.1'