Evolution

Data API / Reporting API v3 / Parameters / Evolution

Foreword

See Postman example

The parameter evo describes the context of the evolution of the analysis. It is composed of different mandatory parameters:

PARAMETER	DESCRIPTION	POSSIBLES VALUES
granularity	Granularity of the evolution	M(onth), W(eek), D(ay), H(our)
top	Description of the selected elements, top of the elements according to the period, pagination and sorting, the number of elements depends on the parameters	See below

TOP PARAMETER	DESCRIPTION	VALEURS POSSIBLES
max-results	–	any number
page-num	–	any number
sort	sort by metrics	any metrics

Don’t forget to remove the sort object if you have an evolution object.

Examples:

• JavaScript
• Shell
• Python
• Ruby

// Basic:
"evo": { 
  "granularity": "D",  // mandatory
  "top": { 
    "max-results": 5, 
    "page-num": 1, 
    "sort": ["-m_visits"]
  } 
} 

// Advanced:

"evo": { 
  "granularity": "D",  // mandatory
  "top": { 
    "max-results": 5, 
    "page-num": 1, 
    "sort": ["-m_visits"], 
    "period": { 
      "p1": [ 
        { 
          "type": "D", 
          "start": "2017-05-12", 
          "end": "2017-05-16" 
        } 
      ] 
    } 
  } 
}

# Basic:
"evo": { 
  "granularity": "D",  // mandatory
  "top": { 
    "max-results": 5, 
    "page-num": 1, 
    "sort": ["-m_visits"]
  } 
} 
# Advanced:

"evo": { 
  "granularity": "D",  // mandatory
  "top": { 
    "max-results": 5, 
    "page-num": 1, 
    "sort": ["-m_visits"], 
    "period": { 
      "p1": [ 
        { 
          "type": "D", 
          "start": "2017-05-12", 
          "end": "2017-05-16" 
        } 
      ] 
    } 
  } 
}

# Basic:
"evo": { 
  "granularity": "D",  // mandatory
  "top": { 
    "max-results": 5, 
    "page-num": 1, 
    "sort": ["-m_visits"]
  } 
} 

# Advanced:

"evo": { 
  "granularity": "D",  // mandatory
  "top": { 
    "max-results": 5, 
    "page-num": 1, 
    "sort": ["-m_visits"], 
    "period": { 
      "p1": [ 
        { 
          "type": "D", 
          "start": "2017-05-12", 
          "end": "2017-05-16" 
        } 
      ] 
    } 
  } 
}

# Basic:
"evo": { 
  "granularity": "D",  // mandatory
  "top": { 
    "max-results": 5, 
    "page-num": 1, 
    "sort": ["-m_visits"]
  } 
} 

# Advanced:

"evo": { 
  "granularity": "D",  // mandatory
  "top": { 
    "max-results": 5, 
    "page-num": 1, 
    "sort": ["-m_visits"], 
    "period": { 
      "p1": [ 
        { 
          "type": "D", 
          "start": "2017-05-12", 
          "end": "2017-05-16" 
        } 
      ] 
    } 
  } 
}