Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This report returns the distribution of a given query within the group of pivots selected.

Report ID: FilterDistribution

Input parameters (see common parameters)

top_k

Parameter name

Type

Required

Description

Default

offsetint(error)The number of results to omit (from the start of the result set)0
rowsint(error)Number of results to return50
evolbool(error)Calculate the evolution of certain fields in the requestFalse
termsstr(tick)Query to searchNoneint
(error)Max results to return by pivot10typeint(error)Type of queries to return (0: all, 1: queries w/results, 2: queries wo/results)0
pivotslist[str](tick)List of pivots to use in the request, separated by commaFilters in config

Responses

200 - successful information retrieve

Type: application/json
Code Block
languagejs
titleExample application/json
collapsetrue
{
    	"data": [
        {
            "filter": "lang",
            "distribution": [
                {
                    "value": "es",
                    "count": 4
                },
                {
                    "value": "pt",
                    "count": 2
                },
                {
                    "value": "es-mx",
                    "count": 2
                }
            ]
        }
    ],
    "params": {
        		{
			"query_count": 357,
			"click_count": 15,
			"wishlist_count": 0,
			"add2cart_count": 0,
			"conversion_count": 0,
			"success_count": 10,
			"pivots": [
				{
					"value": "desktop",
					"pivot": "scope"
				}
			]
		}
	],
	"params": {
		"site_id": "samplesite_id",
        		"start_date": 15278976000001530403200000,
        		"end_date": 15279840000001535760000000,
        		"filters": [],
        "offset": 0,
        "rows": 50,
        "evol": false,
        "top_k": 10,
        "		"pivots": [
            "lang"
        ],
        			"scope"
		],
		"terms": "camisajeans",
        "terms_hash": 8926468711736637978,
        "		"type": 0
    	}
}