Data API » Rest API » Response structure & Parameters » Structure of the response

Structure of the response

JSON

{
"DataFeed": [
	{
		"context" : {
			"spaces" : [ ... all the info about spaces ... ],
			"periods" : [ ... all the info about periods ... ],
			"ranges" : [ ... all the info about page results ... ],
			"profiles" : { ...language and first day of week ... }
		},
		"Columns": [ ... all the metadata for columns ... ],
		"Rows": [ ... all the items/values ... ],
		"totals" : [ ... all the total values for metrics ... ],
		"references" : [ ... all the reference values for metrics ... ]
	},
	{
		"context" : {....},
		"Columns": [ ... all the metadata for columns ... ],
		"Rows": [ ... all the items/values ... ],
		"totals" : ( ... all the total values for metrics ... ],
		"references" : [ ... all the reference vales for metrics ... ] 
	},
	and so on for each dataset 
]
}

XML

<?xml version="1.0" encoding="utf-8"?>
<DataFeed xmlns="http://atinternet/format" >
<dataset ID=1 .....>
	<context>
		many objects : <periods>, <ranges>, <spaces>, <profile>
	</context>
	<columns>
		definition for all the columns
	</columns>
	<rows> 
		all the results, row by row
	</rows> 
	<totals>
		Sum of the values for each metric
	</totals>
	<references>
		overall reference value for each metrics
	</references>
</dataset>
<dataset ID=2 .....>
	other dataset
</dataset>
</dataFeed>

HTML

<html>
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<style type="text/css>table( border-collapse:collapse; }</style>
	</head>
	<body>
		<table border="1px">
			<tr>
				<td> as many tables as context if requested </td>
			</tr>
		</table>
		<table border="1px">
			<tr>
				<td> 1 row for the title of the columns (dimensions/metrics) </td>
			</tr>
			<tr>
				<td> all the results, row by row </td>
			</tr>
		</table>
		<table border="1px">
			<tr>
				<td colspan="N">Totals/references</td>
				<td> requested metric names </td>
			</tr>
			<tr>
				<td colspan="N"> label </td>
				<td> values for each metric, row by row</td>
			</tr>
		</table>
		and so on if other dataset 
	</body>
</html>

IQY

If you wish to use the IQY connector in order to build dashboards in Excel that are linked to our API, we will generate a specific URL adapted to Excel that corresponds to the HTML format:

https://apirest.atinternet-solutions.com/iqy/v2/getData?querystring

This format can be generated from Data Query when exporting a data set.

Please refer to this note if you’re using SSO to login to AT Internet services.

Last update: 22/01/2019

Developers » Data API » Rest API » Response structure & Parameters » Structure of the response