Data Services

  2. Home
  4. Data Services
  6. REST-Report API
  8. Access & Using

Access & Using

Purpose of the REST Report API

The etracker REST Report API is an interface you can use to develop your own applications using the etracker data or to further process this data at your company.

Access to the REST Report API

The REST Report API is available in the etracker Analytics Enterprise Edition. To use it, a so-called access token is necessary. You can create this as administrator/(main)user in the etracker account under Settings → Account → Integrations.

Note:

In order to protect your privacy and prevent unauthorised use of the etracker Web Services API, you should keep the access token confidential.

Using the REST Report API

To simplify using the etracker REST Report API, you should create a REST client. The structure of the client depends on the programming language used. The client sends the queries to the service and returns defined values which can then be further processed.

Apart from the development environment for the programming language used, you will not need any additional software or installation on your system.

Structure of the URL for the REST Calls

The etracker REST API only accepts calls via https. All of the calls described in this document are GET queries. The address of the etracker REST Server is ws.etracker.com and the basic URL for all queries is /api/rest/v6. The REST calls can be written with or without parameters. REST calls for calling report data without parameters are not recommended as under certain circumstances very large data quantities are returned. The parameters do not differentiate between upper and lower case. Example with parameters for calling data from the report ‘Device’: 

https://ws.etracker.com/api/v6/report/EADeviceType/data?limit=401

The same example without parameters (not recommended): 

https://ws.etracker.com/api/v6/report/EADeviceType/data

Return Values

The format of the return values of etracker REST Report API queries is either JSON or CSV. CSV is only supported when querying report data and only returns when the format is queried explicitly. With the JSON returns, one JSON array or JSON object always comes back even if just one value is returned. The etracker REST Report API works with the coding UTF-8. All data which the API provides or receives must be coded in UTF-8. Special characters like German umlauts are partially returned in the form of JavaScript Escape sequences. An “ä” character, for example, would be “\u00e4” in the return data. Most JSON parsers automatically convert these kinds of Escape sequences into letters.

Authentication

Each REST Report query must have a header. This is for performing the authentication to the API.

The following header information is mandatory:

X-ET-Token: This header element contains the access token, that can be created in etracker Enterprise accounts. The access token is only valid for the account in which it was created.

Example:

X-ET-Token=a6175135242a86b1fe518d42095c2hes03ea5d4682597620bc62375a92b8b0c287a558e0e89c8a1edc953gaxda94389b

In Firefox or Chrome, you can use the Modify Headers extension to send these headers.

Old access method for the etracker REST Report API

If you have requested a Developer Token via the etracker Customer Service to use the REST Report API, this is still valid and this access method is still supported. This means that it is still possible to request reporting data using this method.

To authenticate each REST report request, the following header information is mandatory:

  • X-ET-email: This header element includes the email address of the developer who has access to the API.
  • X-ET-developerToken: This header element includes the developer token which you can request from the etracker Support.
  • X-ET-accountId: This element includes the etracker account ID. For authentication purposes, an etracker sub-user can also be entered (format: #accountId#-#subuserId#)
  • X-ET-password: This element includes the password of the etracker account.

Example:

X-ET-email=qa@etracker.com X-ET-developerToken=ab7891ca89d9b4d10dc1703a7f0214256babe6c9 X-ET-accountId=18854 X-ET-password=demo

In Firefox or Chrome, you can use the Modify Headers extension to send these headers.