Retrieve Products

get

https://stg.api.bazaarvoice.com/data/products.json

Products Api is used to get details about a particular product or all the products for a particular passkey.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

apiversion

number

required

The API version

passkey

string

required

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

Attributes

string

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.

Callback

string

Callback function name used with JSONP. Value is a string consisting of the following characters: a-z,A-Z,0-9,_ (excluding comma)

ExcludeFamily

boolean

Boolean flag indicating whether to exclude content from other products in the same family as the requested product.

Filter

array of strings

Filter criteria for primary content of the query. Multiple filter
criteria are supported. Here you can find few of many options we can use the filter parameter

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 Products with Id 50 OR 75.
Advanced operators can be used to define filters. For instance, "Filter=Id:lte:100" will match all Products with an Id value of less than or equal to 100. All advanced operators are documented on the Conversations API page.
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.
Multiple filters are allowed as URL parameters in which case filters are AND'ed. For instance, "filter=IsActive:eq:false&filter=IsDisabled:eq:false" will match all Products that are neither Active nor Disabled.

Below we will be stating few examples of the filter parameter

Single Filter value: &filter=Id:product01
Comma Seperated Multiple Filter values: &filter=Id:eq:Product1,d7873e29-5a90-4875-b91e-01aa96564882
Multiple Filter AND'ed value: &filter=IsActive:eq:false&filter=Id:product01&filter=.....

Filter

Filter_[TYPE]

string

Filtering option for included nested content. TYPE can be any related content, i.e., Reviews, Questions, Answers, Comments, Authors, Categories.

IncentivizedStats

boolean

If set to true, displays the number of incentivized reviews for each product or author returned in the response within an IncentivizedReviewCount element. This parameter must be used in conjunction with the Include parameter to include authors or products in the response, and also with the FilteredStats or Stats parameters to include statistics for reviews in the response.

Include

string

Related subjects to be included (e.g. Products, Categories, Authors, Reviews, Questions.

Limit

integer

Max number of records returned. An error is returned if the value passed exceeds 100.

Limit_[TYPE]

integer

Limit option for the nested content type returned. TYPE can be any related content i.e.Reviews, Questions, Answers, Comments, Authors, Categories. An error is returned if the value passed exceeds 20.

Locale

string

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.

Offset

integer

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.

string

Full-text search string used to find UGC.
Results can not be sorted when using Search.
Search is only available to requests filtered by one product ID.

Sort

array of strings

Ways to sort Products

Sort order is required (asc or desc). There is no default.
Multi-attribute sorting is supported by using a comma separated list of sort criteria for a content/subject type. e.g. sort=rating:asc,submissiontime:desc

Below we will be stating few examples of the sort parameter

Single Sort value: &sort=rating:desc
Multiple Sort values AND'ed: &sort=rating:asc&sort=submissiontime:desc

Sort

Sort_[TYPE]

string

Sorting option for nested content. Sort order is required (asc or desc). TYPE can be any related content, i.e., Reviews, Questions, Answers, Comments, Authors, Categories.

Stats

string

The type of statistics that will be calculated on included subjects. Available content types are: Reviews, Questions, Answers. Note: Not all statistical content types apply to every possible include.

Responses

200Successful response

400Bad Request

401Unauthorized Request

429Too Many Request Error

500Internal Server Error