Get Data Statistics Json

Retrieve Statistics

GET/data/statistics.json

Use it in a workflow

Add a step and choose the Bazaarvoice connector.
Pick the Get Data Statistics Json action (under display).
Fill in the fields below, then reference the result from later steps as {{getDataStatisticsJson.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.

filterarray<string>required

Filter criteria for content of the query. Must be Product IDs. - Each filter argument specifies the attribute to filter on followed by a comma-separated list of values. For instance, "Filter=ProductId:eq:Product1,Product2" returns statistics for Product1 and Product2. - 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. Below we will be stating few examples of the filter parameter - Single Filter value: &filter=ProductId:Product1 - Comma Seperated Multiple Filter values: &filter=ProductId:eq:Product1,Product2

statsstring

The content type for which statistics should be included. Currently available types: Reviews: returns statistics for all content, including syndicated content (if enabled on your API key). NativeReviews: returns statistics only for content submitted on your site; Syndicated content and product family content are excluded.

Callbackstring

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

IncentivizedStatsboolean

If set to true, displays the number of incentivized reviews for each product returned in the response within an IncentivizedReviewCount element. This parameter must be used in conjunction with the Stats parameter.

Response

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

Limitnumber

Offsetnumber

TotalResultsnumber

Localestring

Resultsarray<object>

ProductStatisticsobject3 fields

Includesobject

HasErrorsboolean

Errorsarray<object>

json

{
  "Limit": 0,
  "Offset": 0,
  "TotalResults": 0,
  "Locale": "string",
  "Results": [
    {
      "ProductStatistics": {
        "ProductId": "string",
        "NativeReviewStatistics": {
          "AverageOverallRating": 0,
          "TotalReviewCount": 0,
          "OverallRatingRange": 0
        },
        "ReviewStatistics": {}
      }
    }
  ],
  "Includes": {},
  "HasErrors": false,
  "Errors": [
    {}
  ]
}

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

Was this page helpful?