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.

The Conversations API lets you programmatically retrieve and submit Bazaarvoice Conversations data for use in your applications. To learn more, go to the Conversations API documentation home page.

Contents

(+ show- hide)

Submit feedback on a review, comment, question, answer.

Examples

The following examples demonstrate feedback requests. For a complete overview of using the Conversations API to gather and display feedback, refer to the Feedback Submission tutorial.

Submitting a helpfulness vote

POST /data/submitfeedback.[FORMAT] HTTP/1.1
Host: [stg.]api.bazaarvoice.com
X-Forwarded-For: [AuthorIPAddress]
Content-Type: application/x-www-form-urlencoded
...

ApiVersion=[latestApiVersion]&ContentType=[ContentType]&ContentId=[ContentId]&FeedbackType=helpfulness&Vote=[HelpfulnessVote]&PassKey=[yourKey]

Ellipses (...) in above example indicate that your app may generate other headers.

Submission of feedback must take the form of an HTTP POST.

Submitting inappropriate feedback

POST /data/submitfeedback.[FORMAT] HTTP/1.1
Host: [stg.]api.bazaarvoice.com
X-Forwarded-For: [AuthorIPAddress]
Content-Type: application/x-www-form-urlencoded
...

ApiVersion=[latestApiVersion]&ContentType=[ContentType]&ContentId=[ContentId]&FeedbackType=inappropriate&PassKey=[yourKey]

Ellipses (...) in above example indicate that your app may generate other headers.

Submission of feedback must take the form of an HTTP POST.

Headers

Name Description
Content-Type

The media-type type of the request body. Value must be application/x-www-form-urlencoded.

Required This field is required in all API requests.

X-Forwarded-For

IP address of content author. This header is only necessary when performing submissions from your server. See Authenticity Tutorial for more information.

Per the Bazaarvoice Authenticity Policy, you must send author IP address attached to each submission. If you fail to send author IP address with your submission, Bazaarvoice may take any action deemed necessary in Bazaarvoice’s sole discretion to protect the integrity of the network. Such actions may include but are not limited to: rejection of your content, halting syndication of your content on the Bazaarvoice network, revocation of your API key, or revocation of your API license.

Alert Failure to submit this field will result in your content being ineligible for syndication, authenticity or other business processes.

Your app may generate other headers.

Parameters

Name Description
[FORMAT]

Response format (json).

Required This field is required in all API requests.

ApiVersion

The API version, e.g. 5.4.

Required This field is required in all API requests.

ContentId

ID of the content with which the feedback is associated.

Required This field is required in all API requests.

ContentType

Type of content with which the feedback is associated (review, question, answer or review_comment).

Required This field is required in all API requests.

FeedbackType

Type of feedback (inappropriate, helpfulness).

Required This field is required in all API requests.

PassKey

API key is required to authenticate API user and check permission to access particular client's data.

Required This field is required in all API requests.

Vote

Helpfulness vote for this content. Valid votes are: Positive, Negative. This parameter is only required for FeedbackType=helpfulness.

Required This field is required in all API requests.

Response format

The following is an example of an inappropriate feedback submission response after submission using HTTP POST:

{
   "Data":{},
   "HasErrors":false,
   "Form":[],
   "FormErrors":{},
   "TypicalHoursToPost":null,
   "SubmissionId":null,
   "Feedback":{
     "Inappropriate": {
       "ReasonText":"",
       "AuthorId":"",
     }
   },
   "Locale":"en_US",
   "Errors":[]
}

The following is an example of a helpfulness vote feedback submission response after submission using HTTP POST:

{
   "Data":{},
   "HasErrors":false,
   "Form":[],
   "FormErrors":{},
   "TypicalHoursToPost":null,
   "SubmissionId":null,
   "Feedback":{
     "Helpfulness": {
       "Vote":"POSITIVE",
       "AuthorId":"",
     }
   },
   "Locale":"en_US",
   "Errors":[]
}

Response elements

Name Description
Data

Section containing the fields and field groups.

HasErrors

Boolean value indicating if there are errors present.

Form

Section containing an array of field and group references.

FormErrors

Section containing an object whose properties represent user input errors. For example, failure to submit the minimum required characters for a particular field.

TypicalHoursToPost

Usual time it takes for the content to get posted.

SubmissionId

Unique ID assigned to content when submission is successful. This value can be used to look up content later.

Feedback

Section containing the feedback data.

Locale

The locale that will be associated with this submission.

Errors

Error section is populated instead of other fields if there is an error with a query syntax or problem executing a query.

Error codes

Value Description
ERROR_ACCESS_DENIED

Insufficient privileges to perform the operation

ERROR_DUPLICATE_SUBMISSION

Duplicate feedback submission

ERROR_FORM_DUPLICATE

The nickname is already in use.

ERROR_FORM_DUPLICATE_NICKNAME

The nickname is already in use.

ERROR_FORM_EMOJI

Emoji are not supported.

ERROR_FORM_INVALID_EMAILADDRESS

Email address is not in the proper format.

ERROR_FORM_INVALID_IPADDRESS

The IP address is invalid.

ERROR_FORM_INVALID_OPTION

The selected option has been removed.

ERROR_FORM_PATTERN_MISMATCH

This field is not in the correct format.

ERROR_FORM_PROFANITY

The content contains inappropriate language.

ERROR_FORM_REJECTED

The submission was rejected.

ERROR_FORM_REQUIRED

A required field was not supplied.

ERROR_FORM_REQUIRED_EITHER

Both of the required hosted authentication parameters are missing.

ERROR_FORM_REQUIRED_NICKNAME

You must enter a nickname.

ERROR_FORM_REQUIRES_TRUE

A field requires a value of true. (e.g., "You must agree to the terms and conditions.")

ERROR_FORM_RESTRICTED

Content provider's age is too young. (e.g., "Content cannot be accepted from minors under age 13.")

ERROR_FORM_STORAGE_PROVIDER_FAILED

The uploaded file could not be stored. Try uploading again later.

ERROR_FORM_SUBMITTED_NICKNAME

This nickname has already been submitted.

ERROR_FORM_TOO_FEW

There must be a minimum number of items contributed for this field.

ERROR_FORM_TOO_HIGH

This field has too many items.

ERROR_FORM_TOO_LONG

The field has too many characters.

ERROR_FORM_TOO_LOW

This field has too few items.

ERROR_FORM_TOO_SHORT

The field doesn't have enough characters.

ERROR_FORM_UPLOAD_IO

The item could not be uploaded. Ensure that it is a valid file type.

ERROR_PARAM_DUPLICATE_SUBMISSION

Duplicate submissions are not allowed for this client

ERROR_PARAM_INVALID_API_KEY

Invalid API Key value

ERROR_PARAM_INVALID_PARAMETERS

Invalid parameter in content submission

ERROR_PARAM_MISSING_USER_ID

This client does not allow unauthenticated submissions. A valid UserId is required.

ERROR_REQUEST_LIMIT_REACHED

Rate limiting error, i.e. too many requests per time interval

ERROR_UNKNOWN

Unknown error (internal server error, for instance)

ERROR_UNSUPPORTED

For unsupported features, clients etc.