INFOnline Reporting API¶

Leistungsbeschreibung v2.0 | 02.06.2023

Serviceumfang¶

Über den Service INFOnline Reporting API können Messwerte auf Stunden-, Tages- und Monatsbasis abgefragt werden. Je nach Messwert können sowohl vorläufige als auch finale aggregierte Daten abgefragt werden. Es stehen alle zum Zeitpunkt der Abfrage verfügbaren Daten pro Messwert zur Verfügung, bei vielen Werten (z.B. Page Impressions) auch nahezu Echtzeitdaten.

Über die INFOnline Reporting API können Sie die Messwerte für alle Digital-Angebote abrufen, die Sie über Ihren Kundenaccount / Ihre Kundenummer bei INFOnline zur Messung angemeldet haben. Sie erhalten regulär pro Kundenaccount 1 API Key für den Abruf. Weitere Keys können hinzugebucht werden.

Die Freigabe des jeweiligen Angebotsinhabers vorausgesetzt, kann der Service auch accountübergreifend - also mit Zugriff auf Digital-Angebote unterschiedlicher Kundenaccounts - bereitgestellt werden. Die Freigabe des Angebotsinhabers muss vorab per Mail erfolgen an: service@infonline.de

INFOnline stellt dem benannten Ansprechpartner regulär 1 API Key für den accountübergreifenden Datenabruf bereit. Weitere Keys können hinzugebucht werden.

Zudem kann das Ausgabeformat der API durch Ihren Techniker gewählt werden. Eine spezifische Buchung eines der Ausgabeformate ist nicht notwendig. Zur Verfügung stehen folgende Formate:

• JSON (Default)
• CSV
• CSV Headless
• XML

Die technische Dokumentation nach OAS3 wird Ihnen online bereitgestellt. Weitere Informationen finden Sie im Kapitel Technische Dokumentation.

Anpassungen und Änderungen an diesem Service sind jederzeit durch die INFOnline möglich. Anpassungen werden rechtzeitig vorab von INFOnline per Mail mitgeteilt.

Bestellung / Beauftragung¶

Die Beauftragung des Service INFOnline Reporting API erfolgt über das INFOnline Kunden Center. Im Bestellformular übermittelt der Auftraggeber die Angaben für die Auftragsbearbeitung (Auftraggeber/Rechnungsempfänger, Angebotskennungen, Messverfahren, Metriken, Aggregationsstufen, Empfänger API Invitation). Der Auftraggeber erhält eine Eingangsbestätigung. INFOnline verifiziert, ob alle notwendigen Informationen für die Bereitstellung des Service zur Verfügung stehen. Ist dies der Fall, erhält der Auftraggeber innerhalb von 3 Werktagen eine Auftragsbestätigung per Mail. Fehlen noch Informationen, kontaktiert INFOnline den Auftraggeber. Die Dauer der Auftragsbearbeitung kann je nach Umfang sowie bei ggf. erforderlichen Freigaben variieren.

Bestellung weiterer API Keys¶

Bei der Buchung des Service INFOnline Reporting API ist ein API Key je Kunde inbegriffen. Sollten Sie weitere Keys mit identischer oder auch abweichender Zugriffsberechtigung benötigen, können Sie die Keys über das Bestellformular im INFOnline Kunden Center beauftragen.

Bereitstellung¶

Nach Prüfung der Beauftragung wird der Service mit der gewählten Zugriffsberechtigung für den Datenabruf Ihrer Digital-Angebote regulär innerhalb von 3 Werktagen von INFOnline aktiviert und ein temporärer Zugang zu Ihrem API Key für die INFOnline Reporting API per Mail an den benannten Kontakt versendet.

Bereitstellung weiterer API Keys¶

Pro Kunde können mehrere API Keys bestellt werden, je nachdem, welchen Leistungsumfang Sie mit dem Key abrufen möchten. Die Bereitstellung erfolgt hier auf gleichem Wege wie die initiale Bereitstellung des im Basisumfang enthaltenen API Keys, über das Bestellformular im INFOnline Kunden Center.

Änderungen an bestehenden API Keys¶

Der für Sie erzeugte API Key enthält spezielle Berechtigungen für den von Ihnen gebuchten Anwendungsfall zum Zeitpunkt der Bereitstellung. Bei Änderungen, etwa durch die Kündigung von Digital-Angeboten oder Buchung von INFOnline Measurement für weitere Digital-Angebote (Angebotskennungen), muss ein neuer API Key erzeugt werden und dieser auf Ihrer Seite ausgetauscht werden. Beauftragen Sie den neuen API Key über das Bestellformular im INFOnline Kunden Center.

INFOnline verifiziert, ob alle notwendigen Informationen für die Bereitstellung des API Keys zur Verfügung stehen. Ist dies der Fall, erhält der Auftraggeber innerhalb von 3 Werktagen eine Auftragsbestätigung per Mail. Fehlen noch Informationen, kontaktiert INFOnline den Auftraggeber.

Die Dauer der Umsetzung kann je nach Anzahl und Umfang der Änderungen sowie bei ggf. erforderlichen Freigaben variieren. Mögliche Änderungen an einem API Key sind:

• Hinzufügen oder Entfernen von Angebotskennungen
• Änderung von Berechtigungen (Zugriff weitere Aggregationen oder Messwerte)

Bearbeitungszeit¶

Die Dauer der Einrichtung beträgt in der Regel drei Werktage. Die Dauer der Einrichtung kann zudem je nach Anzahl API Keys, Umfang und Kennzahlen sowie bei ggf. erforderlichen Freigaben variieren. Sollte es an einem Punkt zu Rückfragen oder Verzögerungen kommen, nimmt das INFOnline Customer Service-Team mit Ihnen Kontakt per Mail auf.

Laufzeit¶

Die Service-Laufzeit beträgt 12 Monate ab der Bestätigung bzw. Auftragsannahme durch INFOnline bis zur Kündigung des Service bzw. bis zur Kündigung des Hauptvertrags zur Messung für die Digital-Angebote des / der zugehörigen Kundenaccounts. Wird der Service-Vertrag nicht innerhalb der Kündigungsfrist durch einen autorisierten Ansprechpartner gekündigt, verlängert sich die Vertragslaufzeit automatisch immer um weitere 12 Monate.

Kündigung¶

Die Kündigungsfrist beträgt 4 Wochen zum aktuellen Laufzeitende.

Zur Kündigung senden Sie bitte eine Mail mit dem Kündigungsgrund an folgende Adresse: service@infonline.de

Sofern Sie die Messung aller Ihrer Digital-Angebote kündigen, läuft der Service automatisch zum Tag des Inkrafttretens der Kündigung des Messvertrags aus.

Kosten¶

Alle genannten Preise verstehen sich netto zuzüglich der aktuell gültigen gesetzlichen Mehrwertsteuer. Für den Service INFOnline Reporting API fällt pro Kunde eine einmalige Einrichtungsgebühr in Höhe von 99,90 € an.

Die monatlichen Gebühren betragen 24,90 €. In der Grundgebühr sind 800 API Calls im Tagesdurchschnitt pro Monat inklusive. Bemessungsgrundlage für die Höhe der monatlichen Grundgebühr ist allein die Anzahl der monatlichen API Calls. Die API Calls werden je Kundenaccount ermittelt.

Wird das in der Grundgebühr enthaltene Kontingent von 800 API Calls je Kunde im Tageschnitt pro Monat überschritten, fallen weitere monatliche Kosten von je 4,90 Euro pro 800 weitere API Calls im Tagesdurchschnitt pro Monat an.

Weitere oder neue API Keys (z.B. bei Kündigung oder Anmeldung von Digital-Angeboten) stellt INFOnline dem Auftraggeber für den Reporting API-Zugriff seines Kundenaccounts kostenfrei bereit.

Die Rechnungsstellung erfolgt monatlich nach Leistungserbringung. Die Rechnung wird als PDF per E-Mail von der Adresse 'debitoren.rechnung@infonline.de' an die Rechnungsstelle des Auftraggebers versendet. (s.a. Regelungen zum Rechnungsversand in aktueller INFOnline Preisliste)

Das Tagesslimit je Kunde liegt bei 10.000 API Calls. Sollten Sie ein höheres Tageslimit benötigen, geben Sie dies bei der Bestellung an oder kontaktieren Sie uns per Mail an: service@infonline.de

Kostentabelle monatliche Kosten¶

Zur Orientierung sind die monatlichen Kosten je API Call Kontingent nachfolgend beschrieben. Bei den API Calls handelt es sich um den Tagesschnitt pro Monat. Sollten Sie den Monatswert für Ihre Kalkulationen benötigen, muss der unten aufgeführte Wert mit den Tagen der Monate multipliziert werden.

*Pro Tag sind standardmäßig pro Kundenaccount maximal 10.000 API Calls möglich.

Datenverfügbarkeit¶

Die Daten sind in unterschiedlichen Aggregationsstufen verfügbar. Bitte beachten Sie, dass bei einigen Werten je Aggregationsstufe eine eigenständige Metrik vorliegt, die nicht anhand der Berechnung vorangegangener Aggregationsstufen erzeugt werden kann.

Folgende Aggregationsstufen sind verfügbar:

Vorläufige Daten werden mit dem Flag "preliminary": true gekennzeichnet.

Wenn Daten angefordert werden, die außerhalb dieser Einschränkungen liegen, wird eine Fehlermeldung ausgegeben.

Verfügbare Daten¶

INFOnline nutzt zur Messung und Erstellung der Metriken mehrere Messverfahren, die unter unserem INFOnline Measurement zusammengeführt werden. Je nach Messverfahren sind unterschiedliche Metriken verfügbar.

Messverfahren¶

• INFOnline Measurement (Werte s. IDAS Reiter INFOnline Measurement)
• INFOnline Measurement Pseudonym (Werte s. IDAS Reiter Pseudonym), consentgebundene Ermittlung von clientbezogenen Metriken
• INFOnline Measurement Zensus (Werte s. IDAS Reiter Zensus), consentfreie Ermittlung von Page Impressions

Standardmäßig werden bei der Abfrage einer Metrik alle verfügbaren Werte aus den einzelnen Verfahren übermittelt. Sollten Sie eine Einschränkung auf eines oder mehrere Messverfahren für Ihre Abfragen benötigen, teilen Sie uns dies gern per Mail mit: service@infonline.de

Metriken¶

• Page Impressions (PIs)
• PIs pro Code (nur für Zensusmessung & INFOnline pseudonym)
• PIs pro URL (nur für Zensusmessung & INFOnline pseudonym)
• Visits (nur für INFOnline Measurement & INFOnline pseudonym)
• Clients (nur für INFOnline pseudonym)
• Qualified Clients (nur für INFOnline Measurement)

Je nach Metrik und Messverfahren wird neben dem Gesamtwert der Metrik auch ein Inlands- und Auslandswert übermittelt. Je nach Metrik und Messverfahren wird zudem ein Flag für vorläufige Daten übermittelt ("preliminary": true oder false). Finale Daten liegen erst nach 2 Tagen vor.

Weitere Informationen¶

Jede Abfrage enthält neben den Messwerten Metadaten.

Technische Informationen¶

Datenschnittstelle¶

Der Zugang zu den Messdaten Ihrer Digital-Angebote wird über eine REST-API realisiert. Je nach Bestellung können Sie die Messwerte sämtlicher Digital-Angebote, die unter Ihrer Kundenummer aktiv sind, mit nur einem API Key abfragen.

Die Abfragen erfolgen über einen HTTP GET Request. Zum Zugriff auf die Daten ist eine Autorisierung notwendig.

Autorisierung¶

Die Autorisierung erfolgt über den individuell erzeugten API Key. Der API Key muss im Header der Anfrage unter authorization hinterlegt werden. Je nach Buchung enthält der API Key nur eine Autorisierung für die Abfrage einzelner Messverfahren, Metriken, Aggregationsstufen oder Angebotskennungen.

Abfrageparameter¶

Der HTTP-GET Request muss/kann folgende Parameter enthalten. Die Parameter werden durch ein &-Zeichen verbunden.

Verfügbare Datenformate¶

Über den Parameter returntype kann aus einem von vier verschiedenen Datenformaten für die abgefragten Metriken gewählt werden. Diese Datenformate stehen zur Verfügung:

• JSON (empfohlen, Standardwert)
• csv
• csv_headless (nicht empfohlen)
• xml

Datenformat csv und csv_headless¶

Um eine bestmögliche Kompatibilität der Abfragen mit dem Datenformat csv oder csv_headless zu ermöglichen, wurde eine feste Spaltensortierung für die Datenausgabe je API Endpunkt (Metrik) gewählt. Die Spalten sind mit einem ; (Semikolon) getrennt. Die Sortierungen lauten wie folgt und gelten für alle Messsysteme.

• Endpunkt: pageimpressions

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

• Endpunkt: visits

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

• Endpunkt: qualifiedclients

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

• Endpunkt: pageimpressionspercode

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

• Endpunkt: pageimpressionsperurl

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

• Endpunkt: clients

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

Änderungen der Sortierung behalten wir uns vor.

Technische Dokumentation¶

Die INFOnline Reporting API ist nach dem Standard OAS3 (OpenAPI Specifictation Version 3) beschrieben. Die Beschreibung inkl. aller abrufbaren Metriken finden Sie hier:

INFOnline Reporting API-Beschreibung

Verfügbarkeit / SLAs¶