Empathy Stats API V2 - Reports - Top Clicked
Owned by Edgar Herrero Uría
This report calculates the top clicks in the system for the selected date range and within the mandatory set of pivots.
Report ID: TopClicked
Input parameters (see common parameters)
Parameter name | Type | Required | Description | Default Value |
---|---|---|---|---|
top_k | int | Number of results by group of pivots | 10 | |
top_pct | float | For each group of pivots percentile of values to return | 0 | |
offset | int | The number of results to omit (from the start of the result set) | 0 | |
rows | int | Number of results to return | 50 | |
evol | bool | Calculate the evolution of certain fields in the response | False | |
pivots | list[str] | Group results by this values | None | |
group | int | Return results grouped by pivots (0: false, 1: true) | 0 | |
type | int | Type of clicks to return (See below, types of clicks) | 0 |
Notes: top_k and top_pct params works together and the max. number of results to return is the minimum value between top_k and results over top_pct.
Types of clicks
- 0 - AUTOCOMPLETE
- 2 - SPONSORED
- 3 - BANNER
- 4 - ORGANIC
- 5 - DIRECT_LINK
- 6 - WISHLIST_ADD
- 7 - WISHLIST_DEL
- 100 - TOPCLICKED
- 101 - SYNONYMIZE
- 102 - SUGGESTION
Responses
200 - successful information retrieve
Type: application/json
Example application/json (group = false) Expand source
{ "data": [ { "product_id": "1337", "click_count": 2, "filters": [ { "filter": "user_type", "values": [ "recurrent" ] }, { "filter": "scope", "values": [ "desktop" ] }, { "filter": "lang", "values": [ "en" ] }, { "filter": "store", "values": [ "example" ] } ] }, { "product_id": "00454890", "click_count": 1, "filters": [ { "filter": "user_type", "values": [ "recurrent" ] }, { "filter": "scope", "values": [ "desktop" ] }, { "filter": "lang", "values": [ "en" ] }, { "filter": "store", "values": [ "example" ] } ] }, { "product_id": "089897890", "click_count": 5, "filters": [ { "filter": "user_type", "values": [ "recurrent", "new" ] }, { "filter": "scope", "values": [ "mobile" ] }, { "filter": "lang", "values": [ "es" ] }, { "filter": "store", "values": [ "example" ] } ] }, { "product_id": "078078978907890", "click_count": 5, "filters": [ { "filter": "user_type", "values": [ "new", "recurrent" ] }, { "filter": "scope", "values": [ "desktop" ] }, { "filter": "lang", "values": [ "es" ] }, { "filter": "store", "values": [ "example" ] } ] }, { "product_id": "7089078978900", "click_count": 4, "filters": [ { "filter": "user_type", "values": [ "recurrent" ] }, { "filter": "scope", "values": [ "desktop" ] }, { "filter": "lang", "values": [ "es" ] }, { "filter": "store", "values": [ "example" ] } ] }, { "product_id": "789078907890", "click_count": 3, "filters": [ { "filter": "user_type", "values": [ "recurrent" ] }, { "filter": "scope", "values": [ "desktop" ] }, { "filter": "lang", "values": [ "es" ] }, { "filter": "store", "values": [ "example" ] } ] }, { "product_id": "102123", "click_count": 3, "filters": [ { "filter": "user_type", "values": [ "recurrent", "new", "ignored" ] }, { "filter": "scope", "values": [ "desktop" ] }, { "filter": "lang", "values": [ "es" ] }, { "filter": "store", "values": [ "example" ] } ] }, { "product_id": "789789078978", "click_count": 2, "filters": [ { "filter": "user_type", "values": [ "recurrent" ] }, { "filter": "scope", "values": [ "mobile" ] }, { "filter": "lang", "values": [ "es" ] }, { "filter": "store", "values": [ "example" ] } ] } ], "params": { "site_id": "sample", "start_date": 1506816000000, "end_date": 1513551600000, "filters": [], "offset": 0, "rows": 10, "evol": false, "top_k": 10, "pivots": [ "lang" ], "group": false, "top_pct": 0, "type": 0 } }
Example application/json (group = true) Expand source
{ "data": [ { "product_id": "078978907890", "click_count": 2, "filters": [ { "filter": "user_type", "values": [ "recurrent" ] }, { "filter": "scope", "values": [ "desktop" ] }, { "filter": "lang", "values": [ "en" ] }, { "filter": "store", "values": [ "example" ] } ] }, { "product_id": "08787809789", "click_count": 1, "filters": [ { "filter": "user_type", "values": [ "recurrent" ] }, { "filter": "scope", "values": [ "desktop" ] }, { "filter": "lang", "values": [ "en" ] }, { "filter": "store", "values": [ "example" ] } ] }, { "product_id": "07878907890", "click_count": 5, "filters": [ { "filter": "user_type", "values": [ "recurrent", "new" ] }, { "filter": "scope", "values": [ "mobile" ] }, { "filter": "lang", "values": [ "es" ] }, { "filter": "store", "values": [ "example" ] } ] }, { "product_id": "708978907890", "click_count": 5, "filters": [ { "filter": "user_type", "values": [ "new", "recurrent" ] }, { "filter": "scope", "values": [ "desktop" ] }, { "filter": "lang", "values": [ "es" ] }, { "filter": "store", "values": [ "example" ] } ] }, { "product_id": "70897897890", "click_count": 4, "filters": [ { "filter": "user_type", "values": [ "recurrent" ] }, { "filter": "scope", "values": [ "desktop" ] }, { "filter": "lang", "values": [ "es" ] }, { "filter": "store", "values": [ "example" ] } ] } ], "params": { "site_id": "sample", "start_date": 1506816000000, "end_date": 1513551600000, "filters": [], "offset": 0, "rows": 10, "evol": false, "top_k": 10, "pivots": [ "lang" ], "group": false, "top_pct": 0, "type": 0 } }