Categories for Data API

Data API » Reporting API v3 » Technical information » Error codes

You can find the list of all possible error codes API Code Status Code Error Message QuotasExceeded_TooManyRequests NumberInt(509) You have... View Article

Data API » Reporting API v3 » Technical information » Terms & conditions

Foreword The Reporting API 3.0 is included in the Analytics Suite Delta. In order to ensure a stability in the... View Article

Data API » Reporting API v3 » Methods » API Methods

getData If you need to return the data of a query, you can use the getData method as described below. https://api.atinternet.io/v3/data/getData?param={"columns":["visit_device_type","m_visits"],"sort":["-m_visits"],"space":{"s":[547656]},"period":{"p1":[{"type":"D","start":"2019-10-24","end":"2019-10-24"}]},"max-results":50,"page-num":1} getRowCount... View Article

Data API » Reporting API v3 » Parameters » Sites

Foreword See Postman example The space parameter allows you to define the scope of the site(s) you need to query. PARAMETER DESCRIPTION... View Article

Data API » Reporting API v3 » Parameters » Properties & metrics

Foreword See Postman example In the columns parameter you can enter all properties and metrics that might be available in the call.... View Article

Data API » Reporting API v3 » Parameters » Period

Foreword See Postman example p1 object is mandatory, it is the main period of analysis. p2 object is optional, it describes the... View Article

Data API » Reporting API v3 » Parameters » Filter

Foreword See Postman example If you want to filter your dataset, you have to use the filter object. You can filter on... View Article

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... View Article

Data API » Reporting API v3 » Parameters » Segment

Foreword The parameter segment describes the context of the segment. It is composed of different parameters: SECTION DESCRIPTION POSSIBLES VALUES... View Article

Data API » Reporting API v3 » Parameters » Sort by

Foreword See Postman example The "-" allows you to sort in a decreasing way. It is possible to sort on as many... View Article

Data API » Reporting API v3 » Getting started » How does it work

Foreword Please read the Terms and Conditions before using this Reporting API. If you want to run some prepared examples on... View Article

Data API » Reporting API v3 » Getting started » Authentification

Foreword An API Key gives the same permissions than the user who created it. If the user loses rights on... View Article

Data API » Reporting API v3 » Getting started » Make your first API call

Basic example You can find in this table the explanation of the main parameters. If you want more information, you... View Article

Data API » Rest API » Custom Variables » List the Custom Site Variables

List the Custom Site Variables In order to list the Custom Site Variables configuration, you can query the following API... View Article

Data API » Rest API » Custom Variables » List the Custom Page Variables

List the Custom Page Variables In order to list the Custom Page Variables configuration, you can query the following API... View Article

Data API » Rest API » Custom Variables » List the Custom Order Variables

List the Custom Order Variables In order to list the Custom Order Variables configuration, you can query the following API... View Article

Data API » Rest API » Campaigns » Add a new campaign

Campaign Creation You can manually create a campaign within the Analytics Suite in order to retrieve the tracking ID. You... View Article

Data API » Rest API » Campaigns » List the campaign types

How to list the campaigns In the Analytics Suite, many traffic sources types can be used: Email campaigns; SEM campaigns;... View Article

Data API » Rest API » Campaigns » List the campaigns

All the campaigns Using our REST API, you can easily list all the campaigns of a site. Here’s the format... View Article

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

JSON { "DataFeed": [ { "context" : { "spaces" : [ ... all the info about spaces ... ], "periods"... View Article

Data API » Rest API » Response structure & Parameters » “space” parameter

Sites The &space={s:#YourSiteID#} parameter allows you to get data relative to your site. Example: to know the number of visits... View Article

Data API » Rest API » Technical specifications » Performance recommandations

Pre-calculation helps accelerate the API calls processing time API calls can be queried on-the-fly. However, when the data set gets... View Article

Data API » Rest API » Response structure & Parameters » “period” parameter

Introduction To request a fixed period, there are “start” and “end” attributes. Nonetheless, syntax short cuts allow you to directly... View Article

Data API » Rest API » Response structure & Parameters » “columns” parameter

Syntax In the &columns= parameter, you can enter all dimensions and metrics that might be available in the call. To... View Article

Data API » Rest API » Response structure & Parameters » “filter” parameter

Two types of filters may be used: one for metrics: numerical (e.g. greater than, lower than, etc.) and one for... View Article

Data API » Rest API » Response structure & Parameters » “segment” parameter

The “segment” parameter allows you to apply a segment on your dataset. Segments can be created directly from the Segments... View Article

Data API » Rest API » Response structure & Parameters » “sort” parameter

When the sort parameter is not specified in the URL, data is sorted according to the first metric, in decreasing... View Article

Data API » Rest API » Response structure & Parameters » “page-num” parameter

The “page-num” parameter allows you to get a very precise results page, in the case of result pagination. By using... View Article

Data API » Rest API » Response structure & Parameters » “max-results” parameter

The “max-results” parameter allows you to specify in advance the number of results that you wish to receive. The maximum... View Article

Data API » Rest API » Response structure & Parameters » “segmentdesc” parameter

When your API URL contains a visitor segment (cohort), you will find in your URL a parameter that will display... View Article

Data API » Rest API » Response structure & Parameters » “sep” parameter

The “sep” parameter allows you to specify in advance the type of decimal separator. This allows for easier insertion in... View Article

Data API » Rest API » Technical specifications » Error Codes

Please find below the full list of error messages returned by the API. ErrorCode Description 1 Unknown error 1001 Incorrect... View Article

Data API » Rest API » Getting started » How does it work?

The Rest API is based on Rest URLs that are used to retrieve the data of your choice. In order... View Article

Data API » Rest API » Technical specifications » Analysis periods

Calls made to the Rest API cannot exceed a period of 45 days by default. Refer to your contract for... View Article

Data API » Rest API » Technical specifications » Number of calls

Calls to the Rest API are unlimited; there is no limit on quantity of calls for a given period. Nonetheless,... View Article

Data API » Rest API » Methods » getdata

To query a data set, you may use the getdata method with the required parameters. Here’s an example of URL... View Article

Data API » Rest API » Methods » getrowcount

If you wish to obtain the number of results of a query, you can use the getRowCount method. From your... View Article

Data API » Rest API » Methods » getmaxdate

This API call indicates the last minute of data that is available. The URL must follow this format: https://apirest.atinternet-solutions.com/data/v2/#format#/getmaxdate?&space={s:#siteID#} The... View Article

Data API » Rest API » Response structure & Parameters » “lng” parameter

The “lng” parameter allows you to choose the language of the results of your query. The following values may be... View Article

Data API » Rest API » Response structure & Parameters » “include” parameter

The “include” parameter allows to enrich the API response with extra contextual data such as the total, the data type,... View Article

Data API » Rest API » Response structure & Parameters » “evo” parameter

To get the evolution of all metrics during a given period, you may use the “&evo=” parameter in the REST... View Article

Data API » Rest API » Response structure & Parameters » “retention” parameter

The retention analysis lets you analyse, over time, the number of unique visitors who visited your website or application, and... View Article

Data API » Rest API » Response structure & Parameters » “code” parameter

What is a short code? When you save a Data Query template, it gives you a short code back. This... View Article

Data API » Rest API » Response structure & Parameters » Fixed periods

Request a fixed period To request a fixed period, there are start and end attributes. Nonetheless, syntax shortcuts allow you... View Article

Data API » Rest API » Response structure & Parameters » Relative periods

Request a relative period Relative periods allow you to use periods that are automatically updated based on the last minute... View Article

Data API » Rest API » Response structure & Parameters » “period” parameter: “H” v. “He” & “MN” v. “MNe”

Choose the context wisely When requesting the API on specific time ranges (hours or minutes), it’s all about deciding whether... View Article

Data API » Rest API » Response structure & Parameters » Parameters compatibility

As explained throughout this document, certain functionalities are not compatible with each other or depending on the context of the... View Article

Data API » Rest API » Getting started » Build the API feeds

Data Query To create your API feeds, you need an access to Data Query. If you dont have one, please... View Article

Data API » Rest API » Getting started » Authentication

Using your credentials When querying the API with an external script, you have to provide your login details using a... View Article

Data API » Rest API » Getting started » Code Samples (PHP, Javascript & Python)

Here are some samples of code you can use to query AT Internet Rest API. Please note that you need... View Article

Data API » Data Flow » General information

Preface AT Internet has developed the Data Flow feature, a new API to extract large amounts of data, at a... View Article

Data API » Data Flow » Technical information

Universes Data Flow makes several universes (families of analysis) available: Visits Events Page Custom Variables (additional tracking required) Publisher (additional... View Article

Data API » Data Flow » Advice and Optimizations

Reconciliation As you will load data from at least two different flows (Events and Visit), you will need to reconcile... View Article

Data API » Data Flow » Error codes

Error Code Description 1 Unknown error 1001 Incorrect login or password 1002 Your contract does not have access to the... View Article

Data API » Data Flow » FAQ

Are there several authentication modes possible? The only way to connect to the API is by using your AT Internet... View Article