INFOnline Reporting API¶

Service Description v2.0 | 02.06.2023

Scope of service¶

The INFOnline Reporting API service can be used to query measured values on an hourly, daily and monthly basis. Depending on the measured value, both preliminary and final aggregated data can be requested. All data available at the time of the query are available for each measured value, for many values (e.g. page impressions) also almost real-time data.

Via the INFOnline Reporting API you can retrieve the measured values for all sites that you have registered for measurement with INFOnline via your customer account / customer number. You regularly receive 1 API key per customer account for the retrieval. Additional keys can be booked.

Subject to the approval of the respective site owner, the service can also be provided across accounts - i.e. with access to sites from different customer accounts. The approval of the site needs to be sent in advance by e-mail to: service@infonline.de. INFOnline regularly provides the named contact person with 1 API key for cross-account data retrieval. Additional keys can be booked.

In addition, the output format of the API can be selected by your technician. A specific booking of one of the output formats is not necessary. The following formats are available:

• JSON (default)
• CSV
• CSV Headless
• XML

The technical documentation according to OAS3 is provided online. Further information can be found in the chapter Technical Documentation.

Adaptations and changes to this service are possible at any time by INFOnline. Adjustments will be communicated in good time in advance by INFOnline by e-mail.

Order / Commissioning¶

The ordering of the INFOnline Reporting API service is carried out via the INFOnline Customer Center. In the order form the ordering party submits the details for order processing (ordering party / invoice recipient, site Ids, measurement methods, metrics, aggregation levels, recipient API invitation). The client receives a confirmation of receipt. INFOnline verifies whether all necessary information for the provision of the service is available. If this is the case, the client receives an order confirmation by e-mail within 3 working days. If information is still missing, INFOnline will also contact the client by e-mail. The duration of order processing may vary depending on the scope of the order and any necessary approvals.

Ordering additional API Keys¶

When booking the INFOnline Reporting API service, one API Key per customer is included. In case you require further keys with identical or different access authorisation, you can order additional keys via the order form in the INFOnline Customer Center.

Provision¶

After checking the order, the service with the selected access authorisation for the data retrieval of your sites will be activated by INFOnline within 3 working days and a temporary access to your API Key for the INFOnline Reporting API will be sent by e-mail to the named contact person.

Provision of further API Keys¶

Several API Keys can be ordered per customer, depending on the scope of services you wish to access with the Key. The provision takes place in the same way as the initial provision of the API Key included in the basic scope, via the order form in the INFOnline Customer Center.

Changes to existing API Keys¶

The API Key generated for you contains special authorisations for the use case booked by you at the time of provision. If changes are made, for example by cancelling sites or booking INFOnline Measurement for further sites (site Ids), a new API Key must be generated and exchanged on your side. Order the new API Key via the order form in the INFOnline Customer Center.

INFOnline verifies whether all necessary information for the provision of the API Key is available. If this is the case, the ordering party will receive an order confirmation by e-mail within 3 working days. If information is still missing, INFOnline will also contact the principal.

The duration of the implementation may vary depending on the number and scope of the changes as well as any necessary approvals. Possible changes to an API Key are:

• Addition or removal of site Ids
• Change of authorisations (access to further aggregations or measured values)

Processing time¶

The duration of the set-up is usually three working days. The duration of the set-up can also vary depending on the number of API Keys, scope and metrics, as well as any approvals that may be required. If there are any queries or delays at any point, the INFOnline Customer Service Team will contact you by e-mail.

Term¶

The service term is 12 months from confirmation or order acceptance by INFOnline until termination of the service or until termination of the main contract for measurement for the sites of the associated customer account(s). If the service contract is not terminated by an authorised contact within the notice period, the contract term shall always be automatically extended by a further 12 months.

Termination¶

The cancellation period is 4 weeks to the current end of the term.

To terminate the contract, please send an e-mail with the reason for termination to the following address: service@infonline.de.

Provided that you cancel the metering of all your sites, the service will automatically expire on the day the cancellation of the metering contract comes into effect.

Costs¶

All prices quoted are net plus the currently applicable statutory VAT. For the INFOnline Reporting API service, a one-off set-up fee of €99.90 is charged per customer.

The monthly fees amount to €24.90. The basic fee includes 800 API calls on a daily average per month. The assessment basis for the amount of the monthly basic fee is solely the number of monthly API calls. The API calls are calculated per customer account.

If the contingent of 800 API calls per customer on a daily average per month included in the basic fee is exceeded, additional monthly costs of 4.90 euros per 800 additional API calls on a daily average per month will be incurred.

INFOnline will provide the client with additional or new API Keys (e.g., in the event of cancellation or registration of sites) free of charge for the reporting API access of its customer account.

Invoicing takes place monthly after the service has been provided. The invoice shall be sent as a PDF by e-mail from the address 'debitoren.rechnung@infonline.de' to the Client's billing office. (see also regulations on sending invoices in current INFOnline price list).

The day limit per customer is 10,000 API calls. If you need a higher daily limit, please indicate this in your order or contact us by mail: service@infonline.de

Cost table monthly costs¶

For orientation, the monthly costs per API call contingent are described below. The API calls are the daily average per month. If you need the monthly value for your calculations, the value listed below must be multiplied by the days of the months.

*A maximum of 10,000 API calls are possible per day per customer account by default.

Data availability¶

The data are available in different aggregation levels. Please note that some values per aggregation level have an independent metric that cannot be generated based on the calculation of previous aggregation levels.

The following aggregation levels are available:

Preliminary data are marked with the flag 'preliminary: true'.

If data is requested that falls outside of these restrictions, an error message will be issued.

Available data¶

INFOnline uses several measurement procedures to measure and create metrics, which are brought together under our INFOnline Measurement. Different metrics are available depending on the measurement procedure.

Measurement method¶

• INFOnline Measurement (for values see IDAS tab INFOnline Measurement)
• INFOnline pseudonym (for values see IDAS tab Pseudonym), consent-bound determination of client-related metrics
• Census measurement (for values see IDAS tab Census), consent-free determination of page impressions

By default, all available values from the individual procedures are transmitted when a metric is queried. If you require a restriction to one or more measurement methods for your queries, please let us know by email: service@infonline.de

Metrics¶

• Page impressions (PIs)
• PIs per code (only for census measurement & INFOnline pseudonym)
• PIs per URL (only for census measurement & INFOnline pseudonym)
• Visits (only for INFOnline Measurement & INFOnline pseudonym)
• Clients (only for INFOnline pseudonym)
• Qualified Clients (only for INFOnline Measurement)

Depending on the metric and measurement procedure, a domestic and international value is transmitted in addition to the total value of the metric. Depending on the metric and measurement procedure, a flag for preliminary data is also transmitted ("preliminary": true or false). Final data will only be available after 2 days.

Further information¶

Each query contains metadata in addition to the measured values.

technical information¶

Data interface¶

Access to the measurement data of your sites is realised via a REST API. Depending on the order, you can query the measured values of all sites that are active under your customer number with only one API key.

The queries are made via an HTTP GET request. Authorisation is required to access the data.

Authorization¶

Authorization takes place via the individually generated API Key. The API Key must be stored in the header of the request under 'authorization'. Depending on the booking, the API Key only contains an authorisation for the query of individual measurement procedures, metrics, aggregation levels or site Ids.

Query parameters¶

The HTTP GET request must/may contain the following parameters. The parameters are connected by a & character.

Available returntypes¶

The parameter returntype can be used to select from one of four different data formats for the queried metrics. These data formats are available:

• JSON (recommended, default value)
• csv
• csv_headless (not recommended)
• xml

Data format csv und csv_headless¶

In order to enable the best possible compatibility of the queries with the data format csv or csv_headless, there is a fixed column sorting for the data output per API endpoint (metric). The columns are separated by ; (semicolon). The sorting is as follows and applies to all measurement systems:

• Endpoint: pageimpressions

system;site;aggregatio;date;exported_at;version;datetime;pis;pisint;pisnat;preliminary

• Endpoint: visits

system;site;aggregation;date;exported_at;version;datetime;visits;visitsint;visitsnat;preliminary

• Endpoint: qualifiedclients

system;site;aggregation;date;exported_at;version;datetime;qclients;preliminary

• Endpoint: pageimpressionspercode

system;site;aggregation;date;exported_at;version;datetime;stage;code;pis;preliminary

• Endpoint: pageimpressionsperurl

system;site;aggregation;date;exported_at;version;datetime;url;pis;hits;hitsint;hitsnat

• Endpoint: clients

system;site;aggregation;date;exported_at;version;datetime;clients;clientsint;clientsnat;preliminary

We reserve the right to make changes to the sorting.

Technical Documentation¶

The INFOnline Reporting API is described according to the OAS3 standard (OpenAPI Specifictation Version 3). The description including all retrievable metrics can be found here:

INFOnline Reporting API Description

Availability / SLAs¶