Request

📘
HTTP POST is required

curl -X POST "https://[stg.]api.bazaarvoice.com/response/v1/clientResponses/reviews/-/responses?passkey={RESPONSE_API_PASSKEY}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -d '{
    "reviewIds": ["reviewId"]
  }'

Parameters

Query parameters

Name	Description	Required
`passkey`	Response API passkey. The example above uses the placeholder value `{RESPONSE_API_PASSKEY}`.	Yes

Headers

Name	Description	Required
`Content-Type`	`application/json`	Yes
`Authorization`	Bearer token in the format `Bearer {ACCESS_TOKEN}`. Refer to OAuth2 Integration for more information.	Yes

Request body

Name	Description	Required
`reviewIds`	Array of review IDs to retrieve response counts.	Yes

Response

Header

HTTP status 200 indicates success. Other header values are documented in the API Response

Body

A successful response will contain a JSON object in the body. Below is an example of a typical retriveal of review response counts:

{
    "counts": [
        {
            "reviewId": "XXXXX",
            "responseCount": 1
        },
        {
            "reviewId": "XXXXX",
            "responseCount": 1
        },
        {
            "reviewId": "XXXXX",
            "responseCount": 1
        }
    ]
}

The definition of the key/values returned in the response body is documented in the API Response

Errors

For a detailed description and solution to Response API errors, refer to Troubleshooting.

The following lists specific errors that may be encountered when retrieving a count of responses for reviews:

ReviewIds must not be empty

The required parameter reviewIds is set to an empty array []

{
    "httpCode": 400,
    "requestURI": "/response/v1/clientResponses/reviews/-/responses",
    "errors": [
        {
            "code": "INVALID_PROPERTY_VALUE",
            "field": "reviewIds",
            "message": "Validation error for ClientResponseResource.request.reviewIds: reviewIds cannot be null or empty"
        }
    ]
}

ReviewId must be a valid reviewId

Alphabetic characters are invalid reviewIds

{
    "httpCode": 400,
    "requestURI": "/response/v1/clientResponses/reviews/-/responses",
    "errors": [
        {
            "code": "INVALID_PROPERTY_VALUE",
            "field": "reviewIds",
            "message": "Validation error for ClientResponseResource.request.reviewIds: reviewId must be a valid positive number"
        }
    ]
}