Feedback Submission

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

๐Ÿšง

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 Feedback Submission API reference here.

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

NameDescription
Content-TypeThe 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-ForIP 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

NameDescription
[FORMAT]Response format (json).

๐Ÿ“
Required
This field is required in all API requests.
ApiVersionThe API version, e.g. 5.4.

๐Ÿ“
Required
This field is required in all API requests.
ContentIdID of the content with which the feedback is associated.

๐Ÿ“
Required
This field is required in all API requests.
ContentTypeType of content with which the feedback is associated (review, question, answer or review_comment).

๐Ÿ“
Required
This field is required in all API requests.
FeedbackTypeType of feedback (inappropriate, helpfulness).

๐Ÿ“
Required
This field is required in all API requests.
PassKeyAPI 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.
VoteHelpfulness 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

NameDescription
DataSection containing the fields and field groups.
HasErrorsBoolean value indicating if there are errors present.
FormSection containing an array of field and group references.
FormErrorsSection containing an object whose properties represent user input errors. For example, failure to submit the minimum required characters for a particular field.
TypicalHoursToPostUsual time it takes for the content to get posted.
SubmissionIdUnique submission event ID referring to successful submission events such as submission, update, and others
FeedbackSection containing the feedback data.
LocaleThe locale that will be associated with this submission.
ErrorsError section is populated instead of other fields if there is an error with a query syntax or problem executing a query.

Error codes

ValueDescription
ERROR_ACCESS_DENIEDInsufficient privileges to perform the operation
ERROR_DUPLICATE_SUBMISSIONDuplicate feedback submission
ERROR_FORM_DUPLICATEThe nickname is already in use.
ERROR_FORM_DUPLICATE_NICKNAMEThe nickname is already in use.
ERROR_FORM_EMOJIEmoji are not supported.
ERROR_FORM_INVALID_EMAILADDRESSEmail address is not in the proper format.
ERROR_FORM_INVALID_IPADDRESSThe IP address is invalid.
ERROR_FORM_INVALID_OPTIONThe selected option has been removed.
ERROR_FORM_PATTERN_MISMATCHThis field is not in the correct format.
ERROR_FORM_PROFANITYThe content contains inappropriate language.
ERROR_FORM_REJECTEDThe submission was rejected.
ERROR_FORM_REQUIREDA required field was not supplied.
ERROR_FORM_REQUIRED_EITHERBoth of the required hosted authentication parameters are missing.
ERROR_FORM_REQUIRED_NICKNAMEYou must enter a nickname.
ERROR_FORM_REQUIRES_TRUEA field requires a value of true. (e.g., "You must agree to the terms and conditions.")
ERROR_FORM_RESTRICTEDContent provider's age is too young. (e.g., "Content cannot be accepted from minors under age 13.")
ERROR_FORM_STORAGE_PROVIDER_FAILEDThe uploaded file could not be stored. Try uploading again later.
ERROR_FORM_SUBMITTED_NICKNAMEThis nickname has already been submitted.
ERROR_FORM_TOO_FEWThere must be a minimum number of items contributed for this field.
ERROR_FORM_TOO_HIGHThis field has too many items.
ERROR_FORM_TOO_LONGThe field has too many characters.
ERROR_FORM_TOO_LOWThis field has too few items.
ERROR_FORM_TOO_SHORTThe field doesn't have enough characters.
ERROR_FORM_UPLOAD_IOThe item could not be uploaded. Ensure that it is a valid file type.
ERROR_PARAM_DUPLICATE_SUBMISSIONDuplicate submissions are not allowed for this client
ERROR_PARAM_INVALID_API_KEYInvalid API Key value
ERROR_PARAM_INVALID_PARAMETERSInvalid parameter in content submission
ERROR_PARAM_MISSING_USER_IDThis client does not allow unauthenticated submissions. A valid UserId is required.
ERROR_REQUEST_LIMIT_REACHEDRate limiting error, i.e. too many requests per time interval
ERROR_UNKNOWNUnknown error (internal server error, for instance)
ERROR_UNSUPPORTEDFor unsupported features, clients etc.