Retrieve Product Categories

get

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

Categories Api is responsible for displaying product related categories 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.

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)

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:5,6" will match all categories with Id 5 OR 6.
Advanced operators can be used to define filters. For instance, "Filter=Id:lte:50" will match all categories with an Id value of less than or equal to 50. 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=AncestorId:eq:5&Filter=IsDisabled:eq:false" will match all categories that are not disabled and that have an ancestor category with Id 5.

Below we will be stating few examples of the filter parameter

Single Filter value: &filter=Id:BV_MISCELLANEOUS_CATEGORY
Comma Seperated Multiple Filter values: &filter=Id:eq:BV_MISCELLANEOUS_CATEGORY,....
Multiple Filter AND'ed value: &filter=Id:BV_MISCELLANEOUS_CATEGORY&Filter=IsActive:eq:false&filter=.....

Filter

Limit

integer

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

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.

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=Id:desc
Multiple Sort values AND'ed: &sort=Id:desc&sort=SubmissionTime:desc

Sort

Responses

200Successful response

400Bad Request

401Unauthorized Request

429Too Many Request Error

500Internal Server Error