How the results are structured:

As you will see in the following examples, the results are shown in the same organized structure as the columns in the Intelligence User Interface. The first part of the response contains the data retrieved with the call, in a section called "rows". These results have a total row count, followed by the requested metrics. The column names in the section called "headers" are ordered as they would be in Intelligence.  

Some more things to note:

  • Not every output will be relevant to your analysis. For example, arrangeType and alias are used for our internal processing and will be delivered with the result only for the time being.
  • For the time being, results will always show Raw Data, but in the future, it could be sample data. This is why you see "calculationDataType": "RAW_DATA" at the beginning of your results.
  • When you see 0000000000, this is the same as seeing the Total row heading in the Intelligence interface.

When using a time range, please make sure you include all the time you wish to see results for. Time value 1 is greater than or equal to the given time, and time value 2 is less than. If you want to see all data for November 8th, the values should be set like so:

"value1": "2020-11-08 00:00:00",

"value2": "2020-11-09 00:00:00"

Examples and Guides: