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.

  • 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 and the basic URI for all queries is /api/rest/v3. 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’:
    The same example without parameters (not recommended):
    The format of the return values of etracker REST 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.

Need help?
Our friendly, knowledgeable support engineers are here for you.