Export possibilities - API

Data Query lets you export your data in several different formats, according to your needs. With the choice of format, you can use the API to import data into your tools, and/or to reprocess the obtained data.

 

 

 

Formats

To import your data into a third-party tool, you can export your data via API, in 3 different formats:

  • HTML
  • XML
  • JSON

You can then import the desired data, in your chosen format, into numerous third-party tools. You may choose the output format using the bar right above the URL:

Whenever you edit your template, this URL is automatically updated. You can easily use the URL by clicking the "Copy URL" icon. Once the string is highlighted, you can simply copy and paste it wherever you need (into your browser, for example).

Tip: You can edit the format directly in your API call:
https://apirest.atinternet-solutions.com/data/v2/xml/getData?&space={s:XXXXX}&period={R:{D:'-1'}}&max-results=20&page-num=1

 

Limits

* Number of API calls

Calls to the REST API can be done in an unlimited manner; there are no limits in terms of quantity of calls during a given period. However, the number of simultaneous calls is limited per user, in order to guarantee consistent service levels.

Each user of the interface has a series of timeslots attributed to him/her during which he/she may call the API. A timeslot is occupied during the time that AT Internet processes the API call, and sends the data back to the user.

When a user users 5 timeslots simultaneously and tries to make a 6th call, he or she will receive the following error message: "Authorised frequency of calls exceeded" (Code 5001). The user will have to wait for one of the timeslots to open in order to be able to call AT Internet's API again.

 

* Number of results rows per API call

You can extract up to 10,000 rows per API call (JSON and XML formats). To extract your analysis' entire dataset, you must use the pagination feature, which will allow you to extract data in batches of 10,000 rows at a time.

 

Shortcodes

Shortcode is a URL that is short and unique; any edits made to your template(s) will automatically be applied to the associated shortcode. It is therefore highly recommended to use the shortcode feature if you wish to integrate data via our API into third-party tools, or if you've built Excel tables with IQY. In doing so, you'll be able to publish your template and edit it, without having to change the URLs that you've automated with your technical team.

Tip: To obtain the shortcode, you must first save your template. It is also possible to overwrite the shortcode if necessary; you'll find more information on this topic in the "API" section.

 

Mandatory and optional parameters

To retrieve data from your analysis that's currently being built, you must first have automatically set up:

  • The site(s) on which your analysis is based
  • At least 1 metric in your analysis
  • At least 1 period in your analysis

 

If you don't modify the configuration, by default you'll have:

  • The number of rows in your analysis limited to 20
  • The format of your API call in JSON
  • The date set to yesterday

> You can view all mandatory and optional parameters of the API in the API section.

Have more questions? Submit a request