Related Questions Display

Returns Related Questions.

❗️

Related Questions is only available to clients on our Conversations PRR platform.

Refer to Conversations PRR Only Features for more information.

Overview

When a user submits a review, or answers a question, we can send them a Thank You Page (TYP). On the TYP, we can also send them a list of related questions in the hopes that they will take the time to answer one or more of those
questions.

There are a range of algorithms available for deciding what questions are "related", including a default algorithm. This documentation does not discuss the various available algorithms or their impact. The choice of algorithm
cannot be controlled through the API, it must be set in the configuration, which can be done through the configuration hub.

Additional Consideration

  • If the author provided via UserId/User is not found in the database, the API user is not informed and a null value is used. This yields the equivalent result of leaving UserId/User out of the request entirely.

Examples

Find related questions for a given product

http://[stg.]api.bazaarvoice.com/data/relatedquestions.[FORMAT]?ApiVersion=[latestApiVersion]&PassKey=[yourKey]&ContentType=Review&productID=[id]

Find related questions for a given product which includes authors and

products

http://[stg.]api.bazaarvoice.com/data/relatedquestions.[FORMAT]?ApiVersion=[latestApiVersion]&PassKey=[yourKey]&ContentType=Review&productID=[id]&UserId=[id]&Include=Authors,Products

Find related questions for a given question

The same question will not be shown again.

http://[stg.]api.bazaarvoice.com/data/relatedquestions.[FORMAT]?ApiVersion=[latestApiVersion]&PassKey=[yourKey]&ContentType=Answer&productID=[id]&QuestionID=[id]

Find next 20 related questions for a given category

http://[stg.]api.bazaarvoice.com/data/relatedquestions.[FORMAT]?ApiVersion=[latestApiVersion]&PassKey=[yourKey]&ContentType=Review&categoryID=[id]&limit=20&offset=40


Parameters

NameDescriptionRequiredDefault Value
[FORMAT]Response format (xml or json)Yes
ApiVersionThe API version, e.g. 5.4.Yes
PassKeyAPI key is required to authenticate API user and check permission
to access particular client's data.
Yes
ContentTypeValue of the type of thank you page serving the related
questions. Supported values include "Review" or "Answer" only.
Yes
CallbackCallback function name used with JSONP. Value is a string
consisting of the following characters: a-z,A-Z,0-9,_ (excluding comma). See the JSONP tutorial for more information.
No
CategoryIdThe id of the category for which you want to find related
questions. Either ProductId or CategoryId must be provided.
No
IncludeRelated subjects to be included (e.g., Products, Categories, and Authors)NoWill only return Questions if not specified
Limit Max number of records returned. An error is returned if the value passed exceeds 100.No10
LocaleLocale to display Labels, Configuration, Product Attributes and Category Attributes in. The default value is the locale defined in the display associated with the API key.No
Offset Index at which to return results. By default, indexing begins at 0 when you issue a query. Using Limit=100, Offset=0 returns results 0-99. When changing this to Offset=1, results 1-100 are returned. Offset is limited to 1000.No0
ProductIdThe id of the product that this content is being submitted on.
One of ProductId or CategoryId must be provided.
No
QuestionIdQuestion ID to ignore (e.g., if you are already looking at that
question and don't want it to display as a related question)
No
RelatedProductsComma-separated list of related product IDs. No initial
existence checking is done on the RelatedProducts parameter. If you pass in a ProductId that doesn't exist, it gets ignored silently.
No
User Value of the encrypted user. This parameter demonstrates that a user has been authenticated. See the Client Master Authentication tutorial for more information.No
UserIdUser's external ID. May not be used if User parameter is present.No

Error codes

ValueDescription
ERROR_ACCESS_DENIEDInsufficient privileges to perform the operation
ERROR_PARAM_INVALID_API_KEYInvalid API Key value
ERROR_PARAM_INVALID_CALLBACKInvalid JsonP callback function name
ERROR_PARAM_INVALID_FILTER_ATTRIBUTEInvalid filter attribute name
ERROR_PARAM_INVALID_INCLUDEDInvalid parameter value
ERROR_PARAM_INVALID_LIMITInvalid limit value
ERROR_PARAM_INVALID_LOCALEInvalid locale code
ERROR_PARAM_INVALID_OFFSETInvalid offset value
ERROR_PARAM_INVALID_PARAMETERSInvalid parameter in content submission
ERROR_PARAM_INVALID_SORT_ATTRIBUTEInvalid sort attribute name
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.