...
Parameter name | Type | Required | Description | Default Value |
---|---|---|---|---|
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 | |
terms | str | Retrieve only categories with this terms in them | None | |
levels | list[int] | Levels of depth within the breadcrumb admitted | None | |
parent_ids | list[str] | IDs of the immediate parent of each category | None | |
success | bool | Order results by successCount | False | |
browsing | bool | Toggle between search data (False) and browse data (True) | False |
'browsing' param
For customers that are tagging navigation (aka browse) events setting this field to True toggles the report to browsing mode: the categories include a "views_data" field and all fields refers to browsing data.
'terms' param
This param is used to trigger the TOP 'n' categories which contain, among its words, the ones specified in this array.
...