--- updatedAt: 2026-03-30T09:14:10.000Z agentTools: projectIndex: https://developers.bazaarvoice.com/v1.0-ConversationsAPI/llms.txt --- # Retrieve Answers Answers Api is used to display answers posted on the questions posted for products. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Conversations Display API", "x-audience": "external-partner", "description": "Conversations API Display operations by Bazaarvoice", "version": "1.0.0" }, "servers": [ { "url": "https://stg.api.bazaarvoice.com", "description": "Conversations Staging API Server" } ], "paths": { "/data/answers.json": { "get": { "tags": [ "default" ], "summary": "Retrieve Answers", "description": "Answers Api is used to display answers posted on the questions posted for products.", "parameters": [ { "name": "apiversion", "in": "query", "schema": { "type": "number" }, "description": "The API version", "required": true, "example": "5.4" }, { "name": "passkey", "in": "query", "schema": { "type": "string" }, "description": "API key is required to authenticate API user and check permission to access particular client's data.", "required": true, "example": "caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4" }, { "name": "Attributes", "in": "query", "schema": { "type": "string" }, "description": "Attributes to be included when returning content. For example, if includes are requested along with the &attributes=ModeratorCodes parameter, both the includes and the results will contain moderator codes. In order to filter by ModeratorCode, you must request the ModeratorCodes attribute parameter.", "example": "ModeratorCodes" }, { "name": "Callback", "in": "query", "schema": { "type": "string" }, "description": "Callback function name used with JSONP. Value is a string consisting of the following characters: a-z,A-Z,0-9,_ (excluding comma)", "example": "custom_Function01" }, { "name": "ExcludeFamily", "in": "query", "schema": { "type": "boolean" }, "description": "Boolean flag indicating whether to exclude content from other products in the same family as the requested product.", "example": "true" }, { "name": "Filter", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "description": "Filter criteria for primary content of the query. Multiple filter\ncriteria are supported. Here you can find few of many options we can use the filter parameter \n- Each filter argument specifies the attribute to filter on followed by a comma-separated list of values. For instance, \"Filter=Id:eq:50,75\" will match all Answers with Id 50 OR 75.\n- Advanced operators can be used to define filters. For instance, \"Filter=Id:lt:100\" will match all Answers with an Id value of less than 100. All advanced operators are documented on the Conversations API page.\n- 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.\n- Multiple filters are allowed as URL parameters in which case filters are AND'ed. For instance, \"Filter=QuestionId:eq:50&filter=isfeatured:true\" will match all featured Answers with QuestionId 50.\n- 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 .\n\nBelow we will be stating few examples of the filter parameter\n- Single Filter value: &filter=Id:1865584\n- Comma Seperated Multiple Filter values: &filter=Id:eq:1675274,1675262,1675260\n- Multiple Filter AND'ed value: &filter=QuestionId:eq:1483881&filter=ProductId:eq:100986399&filter=.....\n" }, { "name": "Include", "in": "query", "schema": { "type": "string" }, "description": "Related subjects to be included (e.g. Products, Categories, Authors, or Answers).", "example": "Products" }, { "name": "Limit", "in": "query", "schema": { "type": "integer" }, "description": "Max number of records returned. An error is returned if the value passed exceeds 100.", "example": "10" }, { "name": "Locale", "in": "query", "schema": { "type": "string" }, "description": "Locale 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.", "example": "en_US" }, { "name": "Offset", "in": "query", "schema": { "type": "integer" }, "description": "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. The maximum supported value is 300000.", "example": "20" }, { "name": "Sort", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": true, "description": "Ways to sort answers\n- Sort order is required (asc or desc). There is no default.\n- Multi-attribute sorting is supported by using a comma separated list of sort criteria for a content/subject type. e.g. Sort=Id:asc,SubmissionTime:desc\n\nBelow we will be stating few examples of the sort parameter\n - Single Sort value: &sort=Id:desc\n - Multiple Sort values AND'ed: &sort=Id:desc&sort=SubmissionTime:desc\n" }, { "name": "Stats", "in": "query", "schema": { "type": "string" }, "description": "The type of statistics that will be calculated on included subjects. Available content types are: Answers, Questions, Reviews. Note: Not all statistical content types apply to every possible include.", "example": "Reviews" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answer" } } } }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "429": { "$ref": "#/components/responses/TooManyRequestsResponse" }, "500": { "$ref": "#/components/responses/InternalServerErrorResponse" } } } } }, "components": { "schemas": { "Answer": { "type": "object", "properties": { "Limit": { "type": "number" }, "Offset": { "type": "number" }, "TotalResults": { "type": "number" }, "Locale": { "type": "string" }, "Results": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "string" }, "CID": { "type": "string" }, "SourceClient": { "type": "string" }, "LastModeratedTime": { "type": "string" }, "LastModificationTime": { "type": "string" }, "QuestionId": { "type": "string" }, "Badges": { "type": "object", "properties": { "top25": { "type": "object", "properties": { "ContentType": { "type": "string" }, "Id": { "type": "string" }, "BadgeType": { "type": "string" } } } } }, "BadgesOrder": { "type": "array", "items": { "type": "string" } }, "AuthorId": { "type": "string" }, "UserLocation": { "type": "string" }, "ContentLocale": { "type": "string" }, "IsFeatured": { "type": "boolean" }, "TotalInappropriateFeedbackCount": { "type": "number" }, "IsBrandAnswer": { "type": "boolean" }, "TotalFeedbackCount": { "type": "number" }, "TotalNegativeFeedbackCount": { "type": "number" }, "TotalPositiveFeedbackCount": { "type": "number" }, "ModerationStatus": { "type": "string" }, "SubmissionTime": { "type": "string" }, "AnswerText": { "type": "string" }, "UserNickname": { "type": "string" }, "Photos": { "type": "array", "items": { "type": "object" } }, "Videos": { "type": "array", "items": { "type": "object" } }, "ContextDataValuesOrder": { "type": "array", "items": { "type": "object" } }, "CampaignId": { "type": "object" }, "SubmissionId": { "type": "object" }, "AdditionalFields": { "type": "object" }, "ContextDataValues": { "type": "object" }, "IsSyndicated": { "type": "boolean" }, "AdditionalFieldsOrder": { "type": "array", "items": { "type": "object" } }, "InappropriateFeedbackList": { "type": "array", "items": { "type": "object" } }, "ProductRecommendationIds": { "type": "array", "items": { "type": "object" } } } } }, "Includes": { "type": "object" }, "HasErrors": { "type": "boolean" }, "Errors": { "type": "array", "items": { "type": "object" } } } }, "BadRequestErrorResponseSchema": { "type": "object", "properties": { "Includes": { "type": "object", "default": {} }, "HasErrors": { "type": "boolean", "default": true }, "Offset": { "type": "number", "default": null }, "TotalResults": { "type": "number", "default": null }, "Locale": { "type": "string", "default": null }, "Results": { "type": "array", "items": { "type": "object", "default": {} } }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "example": "The passKey provided is invalid." }, "Code": { "type": "string", "example": "ERROR_PARAM_INVALID_API_KEY", "x-extensible-enum": [ "ERROR_PARAM_INVALID_API_KEY", "ERROR_PARAM_INVALID_CALLBACK", "ERROR_PARAM_INVALID_FILTER_ATTRIBUTE", "ERROR_PARAM_INVALID_INCLUDED", "ERROR_PARAM_INVALID_LIMIT", "ERROR_PARAM_INVALID_LOCALE", "ERROR_PARAM_INVALID_OFFSET", "ERROR_PARAM_INVALID_SORT_ATTRIBUTE", "ERROR_PARAM_INVALID_SEARCH_ATTRIBUTE", "ERROR_UNKNOWN", "ERROR_UNSUPPORTED" ] } } } } } }, "UnauthorizedErrorResponseSchema": { "type": "object", "properties": { "Includes": { "type": "object", "default": {} }, "HasErrors": { "type": "boolean", "default": true }, "Offset": { "type": "number", "default": null }, "TotalResults": { "type": "number", "default": null }, "Locale": { "type": "string", "default": null }, "Results": { "type": "array", "items": { "type": "object", "default": {} } }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "example": "You are not authorized to make this request." }, "Code": { "type": "string", "example": "ERROR_ACCESS_DENIED", "x-extensible-enum": [ "ERROR_ACCESS_DENIED" ] } } } } } }, "UnknownErrorResponseSchema": { "type": "object", "properties": { "Includes": { "type": "object", "default": {} }, "HasErrors": { "type": "boolean", "default": true }, "Offset": { "type": "number", "default": null }, "TotalResults": { "type": "number", "default": null }, "Locale": { "type": "string", "default": null }, "Results": { "type": "array", "items": { "type": "object", "default": {} } }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "example": "Unknown error encountered." }, "Code": { "type": "string", "example": "ERROR_UNKNOWN", "x-extensible-enum": [ "ERROR_UNKNOWN" ] } } } } } }, "TooManyRequestErrorResponseSchema": { "type": "object", "properties": { "Includes": { "type": "object", "default": {} }, "HasErrors": { "type": "boolean", "default": true }, "Offset": { "type": "number", "default": null }, "TotalResults": { "type": "number", "default": null }, "Locale": { "type": "string", "default": null }, "Results": { "type": "array", "items": { "type": "object", "default": {} } }, "Errors": { "type": "array", "items": { "type": "object", "properties": { "Message": { "type": "string", "example": "Please try again later." }, "Code": { "type": "string", "example": "ERROR_REQUEST_LIMIT_REACHED", "x-extensible-enum": [ "ERROR_REQUEST_LIMIT_REACHED" ] } } } } } } }, "responses": { "BadRequestResponse": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponseSchema" } } } }, "UnauthorizedResponse": { "description": "Unauthorized Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorResponseSchema" } } } }, "TooManyRequestsResponse": { "description": "Too Many Request Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestErrorResponseSchema" } } } }, "InternalServerErrorResponse": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnknownErrorResponseSchema" } } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true, "samples-enabled": true } } ```