Versions Compared

Key

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

...

Parameter nameTypeRequiredDescriptionDefault Value
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 responseFalse
termsstr(error)Retrieve only categories with this terms in themNone
levelslist[int](error)Levels of depth within the breadcrumb admittedNone
parent_idslist[str](error)IDs of the immediate parent of each categoryNone
successbool(error)Order results by successCountFalse
browsingbool(error)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.

...