v1

latestOpenAPI 3.0.32026-07-22177397578.0 KB
Product

Get product counters

Retrieves view, add-to-cart, and transaction counts for multiple products.

get/product/productCounters

Query parameters

siteCodestring required

The Kameleoon project ID.

eansstring required

JSON array of <product Id / EAN: string>.

A JSON array of product IDs or EANs. For example, <code>["ean1","ean2"]</code>. Limit the array to 100 products.

timeBegininteger

The date to begin querying from (UNIX millisecond timestamp format). This date is inclusive.

timeEndinteger

The date to query to (UNIX millisecond timestamp format). This date is exclusive.

prettyPrintboolean

Set to <code>true</code> for a "pretty" printed response.

Headers

user-agentstring required

Not always required. Kameleoon rejects an incoming request if the source is a bot or spider, based on IAB/ABC user-agent filtering rules. Kameleoon uses a single-pass method. You don't need to take specific action when sending requests from a web browser using a standard library (XHR). However, in other cases, set a custom value for the User-Agent request header to overwrite the default value the library sets.

Response

Successful operation, products counters are rendered, of type JSON object {"<product Id / EAN>": <product counters>}, with <product counters> of type JSON object {"v": <number of views = integer⁄int32>, "atcq": <add to cart quantities = integer⁄int32>, "bq": <transaction quantities = integer⁄int32>}