In addition to the already existing SOAP interface, the Reporting API offers the possibility to obtain statistical, tracking and scoring data. This data can then be integrated, evaluated and visualized in business intelligence solutions and dashboards.
Authentication is via HTTP Basic Auth (external link)
Access to the API is possible only over HTTPS and requires the right Reporting API. Table-specific rights are also required, which are described for the tables.
A request for the Reporting API is made via the login domain. The login domain depends on the instance on which your account is located. For example, the login domain can be as follows:
The request can therefore be made to the following ULR, for example:
To ensure that the correct user is used, we recommend that the user name be prefixed:
The following parameters are available for the request:
- format (mandatory)
Output format of date and time specifications
Date and time information is saved in the iso8501 time_format
are possible formats:
Time restriction of queries
The parameters from to
from=<date string> to=<date_string> yesterday, last monday, now-24hours, etc
Output formats (format)
The parameter "format" in the URL defines the desired output format of the requested data.
|Parameter value||Description||MIME type|
|xml||XML representation of the data||application/xml|
|json or jsonarray||Representation of the data as a list from json||application/json|
|jsonobject||Representation of the data as a single json object||application/json|
|csv||CSV representation of the data||text/csv|
The output language affects the column "name" of the table "resourcetypes", as well as the table "profiles" (e.g. the values of the columns, SALUTATION, COUNTRY, etc.)