“evo” parameter

To get the evolution of all metrics during a given period, you may use the “&evo=” parameter in the REST string. This parameter needs 2 pieces of information:

  • The granularity of evolution, according to the following nomenclature:
    • Mn: minute to minute (for a visit)
    • Mne: minute to minute (for an event)
    • H: hour to hour (for a visit)
    • He: hour to hour (for an event)
    • D: day to day
    • W: week to week
    • M: month to month
    • Q: trimester to trimester
    • S: semester to semester
    • Y: year by year.
  • The evolution period (optional if the REST call relies on just 1 period)

The evolution period does not necessarily apply to the period for which dimensions are sorted. The selection of dimensions can apply to period p1, and the evolution can apply to period p2.

Example: evolution period is identical to period for selected elements

&period={p1:{M:2016-09}}&columns={d_geo_country,p1.m_visits}&evo={D,p1}&filter={d_geo_country:{$eq:'france'}}&sample={first:5}&sort={-p1.m_sales}

Here, we get the day-by-day evolution for September 2016 for the first 5 countries filtered on “FR” that have had the largest turnover (in September 2016).

Example: evolution in the case of a call applied to several periods (the Evolution mode only applies to one of these call periods: p2).

&period={p1:{M:2016-12},p2:{W:2016-22}}&Columns={d_geo_country, p2.m_visits}&evo={D,p2}&filter={d_geo_country:{$lk:'fr'}}&sample={first:5}&sort={-p1.m_sales}

Here, we get the day-by-day evolution for Week 22 of year 2016 (p2) of the first 5 countries filtered on “FR” that have had the largest turnover in December 2016 (p1).

If a single period is requested, then p1 is not necessary. Going back to the first example:

&period={M:2016-12}&Columns={d_geo_country,m_visits,m_sales}&evo={D}&filter={d_geo_country:{$lk:'fr'}}&sample={first:5}&sort={-m_sales}

The sort parameter is necessary in order to use evo.

All metrics of the columns parameter must refer, at the very least, to the period used for evolution.

The maximum number of items for the selected dimension is 30 (maxResults=30). For each of these items, the maximum number of rows is 10,080 (which corresponds to 1 week, minute-by-minute).

Filters and sorting can only apply to metrics from the first period.

Depending on the requested granularity, the format of data output will automatically add columns to translate each period.

The evo parameter can’t be used with period-related dimensions.

Was this post helpful?
Yes
No
Last update: 31/07/2017