Q&A PDP Components

This tutorial describes the standard product display page (PDP) components that make up Bazaarvoice Conversations Questions and Answers (Q&A).

Introduction

Conversations Q&A consists of two PDP components:

  • Q&A summary
  • Content area

Each component is described in more detail below along with a wireframe identifying where on a typical PDP it should be placed, a list of recommended elements, and a screenshot of the default Bazaarvoice implementation as an example. Although not required, we strongly encourage the inclusion of these components in your Conversations application.

Q&A summary

Description

The Q&A summary alerts the consumer to the existence of questions and answers as well as provides links for reading and writing questions and answers. It should be displayed towards the top of the product page, above the fold.

This component should contain the following elements:

  • Count of total questions and answers
  • Link to read questions and answers
  • Link to ask a question

User interface

The following images show what this component might look like:

No questions

Questions

Summary data

Data used to create the Q&A summary can be found in the QAStatistics section of the API response:

{
  "HasErrors": false,
    "Includes": {
      "Products": {
        "1000001": {
          ...
          "QAStatistics": {...},
            ...
                          }
        },
          "Answers": [...],
         ...
       },
       "Offset": 0,
       "TotalResults": 1,
       "Locale": "en_US",
       "Errors": [],
       "Results": [...],
       "Limit": 10
}

The QAStatistics object is not included in the API response by default. Add Include=Products and Stats=Questions to questions.json to request QAStatistics.

https://[stg.]api.bazaarvoice.com/data/questions.json?apiversion=5.4&passkey={API_KEY}&Filter=ProductId:1000001&Include=Products,Answers&Stats=Questions

πŸ“˜

Refer to the reference documentation to learn more about making Conversations API requests.

Content area

Description

The content area is where the consumer generated content is displayed. This area is typically displayed after product information and may be behind a tab.

This component should contain the following elements:

  • Questions and answers
  • Sort and filter controls
  • Pagination controls
  • Link ask a Question
  • Links answer questions

User interface

The following images show what this component might look like:

No questions

Questions

Content data

Data used to create the Q&A content area can be found in the Answers and Results sections of the API response:

{
  "HasErrors": false,
    "Includes": {
      "Products": {
        "1000001": {
          ...
          "QAStatistics": {...},
            ...
                          }
        },
          "Answers": [...],
         ...
       },
       "Offset": 0,
       "TotalResults": 1,
       "Locale": "en_US",
       "Errors": [],
       "Results": [...],
       "Limit": 10
}

The Answers array is not included in the API response by default. In the request below, Answers when added to Include instructs the API to return Answers.

https://[stg.]api.bazaarvoice.com/data/questions.json?apiversion=5.4&passkey={API_KEY}&Filter=ProductId:1000001&Include=Products,Answers&Stats=Questions

πŸ“˜

Refer to the reference documentation to learn more about making Conversations API requests.