Retrieve Statistics

Statistics Api is responsible for pulling up all sort of statistics like review statistics for a product or multiple products or even question and answer related statistics.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
required

The API version

string
required

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

filter
array of strings
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
filter*
string

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.

string

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.

boolean

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.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json