younifyd
Menu

Get Data Categories Json

Retrieve Product Categories

GET/data/categories.json

Use it in a workflow

  1. Add a step and choose the Bazaarvoice connector.
  2. Pick the Get Data Categories Json action (under display).
  3. Fill in the fields below, then reference the result from later steps as {{getDataCategoriesJson.response.data}}.

Request

Query parameters

apiversionnumberrequired

The API version

passkeystringrequired

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

Callbackstring

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

Filterarray<string>

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=.....

Limitinteger

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

Localestring

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.

Offsetinteger

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.

Sortarray<string>

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

Response

Returns 200 with an object. Read it in later steps with {{getDataCategoriesJson.response.data.<field>}}.

Limitnumber
Offsetnumber
TotalResultsnumber
Localestring
Resultsarray<object>
Activeboolean
Disabledboolean
Namestring
Idstring
ParentIdstring
CategoryPageUrlstring
QuestionIdsarray<object>
ImageUrlstring
ProductIdsarray<object>
Attributesobject
StoryIdsarray<object>
AttributesOrderarray<object>
Includesobject
HasErrorsboolean
Errorsarray<object>
json
{
  "Limit": 0,
  "Offset": 0,
  "TotalResults": 0,
  "Locale": "string",
  "Results": [
    {
      "Active": false,
      "Disabled": false,
      "Name": "string",
      "Id": "string",
      "ParentId": "string",
      "CategoryPageUrl": "string",
      "QuestionIds": [
        {}
      ],
      "ImageUrl": "string",
      "ProductIds": [
        {}
      ],
      "Attributes": {},
      "StoryIds": [
        {}
      ],
      "AttributesOrder": [
        {}
      ]
    }
  ],
  "Includes": {},
  "HasErrors": false,
  "Errors": [
    {}
  ]
}

Need more? See the Bazaarvoice guide for connection setup and behaviour shared by every action.