v1

latestOpenAPI 3.0.12026-07-139031.1 KB
products
aggregates

Fetch aggregate product statistics for your site

This endpoint will return aggregated product feedback statistics for the lifetime of your Shopper Approved account as well as aggregates for all of your products.

get/aggregates/products/{siteid}

Path parameters

siteidinteger required

The SiteId you are requesting statistics for

Query parameters

tokenstring required

Your API token.

by_match_keyboolean

If true, this will display your product aggregate information by a matching key such as SKU or MPN. Results vary by site, only use this if you're confident it is what you need

asArrayboolean

If true, this will return the response as a JSON arry as opposed to the standard JSON object. (Enclosed in [] as opposed to {}.)

siteOnlyboolean

If true, this will return only the site_totals object and leave out specifics about each product.

xmlboolean

If true, this will return an XML tree instead of a JSON response.

fastmodeboolean

If true, use a highly optimized query. However, by_match and as_array will always be ignored in this mode.

Response

Success - A JSON object with statistics will be returned