Search Knowledge Base by Keyword
XML-Download
Folgen Sie bitte diesem Link.
Serviceumfang
Über den Service XML-Download werden Messwerte auf Stunden- und Tagesbasis und auf Zeiträume aggregiert nach Datum bereitgestellt. Kleinere Zeiteinheiten (z.B. Echtzeitdaten) stehen nicht zur Verfügung.
Bestellung / Beauftragung
Die Beauftragung des Services XML-Download erfolgt über das INFOnline Bestell Center unter https://kundencenter.infonline.de/#module/ordercenter.
Danach wird durch INFOnline verfiziert, ob es technische Gründe im Messsystem gibt, die eine Aktivierung des Service für Ihr Digital-Angebot verhindern. Hierzu wird der Auftraggeber informiert.
Bereitstellung
Nach Prüfung der Beauftragung wird der Service für Ihr Digital-Angebot im Messsystem aktiviert. Der Zugang zum Webportal ist über eine Authentisierung geschützt.
Die Zugangsdaten sowie die technische Beschreibung der Schnittstelle (inkl. der benötigten URL) erhalten Sie mit der Einrichtungsbestätigung per Mail. Pro Digital-Angebot wird ein separates Login erstellt.
Bearbeitungszeit
Die Dauer des Einrichtungsablaufs (Prüfung und Aktivierung) beträgt in der Regel drei Werktage.
Sollte es an einem Punkt dieses Ablaufs zu Rückfragen o.ä, kommen, nimmt das INFOnline Customer Service-Team mit Ihnen zwecks Klärung Kontakt auf.
Datenverfügbarkeit
- Stundendaten („aggr=hour“) können maximal 3 Tage zurück abgerufen werden.
- Tagesdaten („aggr=day“) können 179 Tage lang abgerufen werden.
- Es können maximal die Daten von 7 Tagen zusammenhängend angefordert werden.
Wenn Daten angefordert werden, die außerhalb dieser Einschränkungen liegen, wird der letzte vorhandene Datensatz ausgegeben.
Laufzeit
Die Service-Laufzeit gilt ab der Bestätigung durch INFOnline bis zur Kündigung des Services bzw. zur Kündigung des Messvertrags für das entsprechende Digital-Angebot.
Kündigung
Die Kündigungsfrist beträgt immer 4 Wochen zum Quartalsende.
Es reicht eine E-Mail mit Kündigungsgrund an folgende Adresse: service@infonline.de.
Sofern Sie die Messung des Digital-Angebots kündigen, läuft der Service automatisch aus.
Kosten
Für den Service XML-Download fällt pro Digital-Angebot eine einmalige Einrichtungsgebühr in Höhe von
100 € (netto zzgl. der aktuell gültigen MwSt.) an. Laufende Kosten fallen nicht an.
Die Rechnungsstellung erfolgt nach Einrichtung des Services für Ihr Digital-Angebot.
Technische Informationen
Datenschnittstelle
Der Zugang zu den Messdaten des Digital-Angebots wird über ein Webportal mit der URL https://xml.ioam.de/xml.php realisiert. Der Zugriff auf die Daten erfolgt nach HTTP-Authentifizierung via Download, die Datenübertragung wird per SSL verschlüsselt.
Jedes von Ihnen angemeldete Digital-Angebot benötigt einen separaten Zugang zum XML-Download.
Die Messdaten liegen in UTF-8 codierten XML-Textdateien ohne BOM (Byte Order Mark) vor.
Namenschema der XML-Dateien
Im Folgenden werden die Namensschemata der möglichen Datenaggregationen bei manuellem Download erläutert.
Stundendaten
Diese XML-Datei enthält die Aggregationsdaten auf Stundenbasis im angegebenen Zeitpunkt.
<Angebotskennung>-hour-<Startzeitpunkt der Aggregation in UTC (Timestamp)>-<Endzeitpunkt der Aggregation in UTC (Timestamp)>
Die Stundendaten stellen den kleinesten verfügbaren Betrachtungszeitraum dar und sind als vorläufig zu erachten. Echtzeitdaten werden nicht bereitgestellt.
Tagesdaten
Diese XML-Datei enthält die Aggregationsdaten auf Tagesbasis im angegebenen Zeitraum.
<Angebotskennung>-day-<Startzeitpunkt der Aggregation in UTC (Timestamp)>-<Endzeitpunkt der Aggregation in UTC (Timestamp)>
Diese Daten stehen erst nach zwei Tagen zur Verfügung, da diese vor der Bereitstellung zunächst final aggregiert werden. Weitere Restriktionen in der Verfügbarkeit der Messdaten im XML-Download finden Sie im Kapitel 2.4 Verfügbarkeit der Daten.
XML-Download Parameter
Die Abfrage der Messdaten über den XML-Download kann durch verschiedene Parameter angepasst werden. Diese beziehen sich auf den Aggregationstyp Stunde/Tag sowie den Zeitraum, in dem die Daten in der XML-Datei aufgeführt werden. Die unterschiedlichen Restriktionen bei der Ausgabe der Daten entnehmen Sie bitte Kapitel 2.4 Verfügbarkeit der Daten.
Durch folgende Parameter kann die URL „https://xml.ioam.de/xml.php“ unter Verwendung des “?“Zeichens (für den ersten Parameter) ergänzt und somit der Inhalt der XML-Datei definiert werden. Jeder weitere Parameter muss durch ein „&“-Zeichen angehangen werden.
- date – Datum des Abfragezeitraums, alternativ Nutzung von {start&end}
- start – Startdatum des Abfragezeitraums, nur in Verbindung mit {end} einsetzbar
- end – Enddatum des Abfragezeitraums, nur in Verbindung mit {start} einsetzbar
- aggr – Aggregation der Abfrage, nur Stunde {hour} oder Tag {day} möglich
Werden einzelne Parameter nicht gesetzt, wird die XML-Datei mit Defaultwerten ausgeliefert. Näher hierzu in der nachfolgenden Beschreibung der Parameter.
date-Parameter
Über den Parameter {date} werden die verfügbaren Messdaten auf ein konkretes Datum eingeschränkt.Im folgenden Beispiel wird neben der URL auch ein Auszug der Ausgabe des dateParameters verbildlicht.
https://xml.ioam.de/xml.php?date=2017-09-01&aggr=day
Diese Einschränkung kann in der Aggregation „hour“ auch auf einzelne Stunden erweitert werden.
https://xml.ioam.de/xml.php?date=2017-09-01-15:00&aggr=hour
Beispielausgaben können in Kapitel 2.6 Beispiele XML-Download eingesehen warden.
start&end-Parameter
Die Parameter {start} und {end} können sinnvoll nur in Kombination verwendet werden und schränken, im Gegensatz zum Parameter {date}, einen Zeitraum ein. Die Parameter „start&end“ können sowohl mit der Aggregation „day“ also auch mit der Aggregation „hour“ verwendet werden. Die so angeforderten Messwerte unterliegen den Regeln zur Verfügbarkeit der Daten (Kapitel 2.4 Verfügbarkeit der Daten).
{Start} = Startdatum der Abfragewerte
{End} = Enddatum der Abfragewerte
https://xml.ioam.de/xml.php?start=2017-09-01&end=2017-09-05&aggr=day
Der Zeitraum der Ausgabe kann zudem um die Angabe einer Uhrzeit erweitert werden, um einen konkreten Zeitraum stundengenau ausgeliefert zu bekommen. Diese Einschränkung ist jedoch nur in Kombination mit der Datenaggregation „hour“ verwendbar.
https://xml.ioam.de/xml.php?start=2017-09-04-12:00&end=2017-09-05-13:00&aggr=hour
Bitten achten Sie auf die jeweiligen Einschränkungen der Datenverfügbarkeit in „Kapitel 2.4 Verfügbarkeit der Daten”.
Verfügbarkeit der Daten
Die Daten im XML-Download sind dynamisch abrufbar. Dieser Abruf unterliegt jedoch gewissen Verfügbarkeiten, damit die zeitgenau ermittelten Daten performant verfügbar sind.
Wichtig!
Alle Zeitangaben in den XML-Dateien sind in UTC gehalten.
- Stundendaten: „aggr=hour“
Daten auf Stundenbasis sind drei Tage rückwirkend abrufbar. Sollten Daten außerhalb dieser Verfügbarkeitsregeln angefordert werden, wird eine der weiter unten aufgeführten Fehlermeldungen ausgegeben.
- Tagesdaten: „aggr=day“
Daten auf Tagesbasis sind 179 Tage rückwirkend abrufbar. Die Aggregation der Tagesdaten ist erst zwei Tage rückwirkend zum aktuellen Datum möglich (z.B. am 06.10. sind die Tagesdaten vom 04.10. verfügbar)! Daten können für maximal sieben zusammenhängende Tage angefordert werden. Wird ein größerer Zeitraum ausgewählt, wird eine der weiter unten aufgeführten Fehlermeldungen ausgegeben.
Fehlermeldungen
- Fehlermeldungen bei invalidem Zeitraum „…“
Sollten Daten aufgrund der Auswahl eines invaliden Zeitraums nicht verfügbar sein, können folgende Werte innerhalb der Dimension auftreten:
- unkown error
- date(XXX) too old
- start(XXX) greater than end(XXX)
- start(XXX) older than max. allowed value (XXX)
- start(XXX) too old
- too much days (XXX/YYY)
- end(XXX) too young
Beispiel-Ausgabe für die Fehlermeldung „start(XXX) greater than end(XXX)“
<error>
start(2017-10-24-10:00) greater than end start(2017-10-06-10:00)
</error>
- Fehlermeldungen bei nicht verfügbaren Daten
Sollten Daten aus anderen Gründen nicht zur Verfügung gestellt werden können, wird in den einzelnen Dimensionen der unterschiedlichen Messwerte (2.5.2 Messdatentypen in der XMLDatei) im XML-Dokument der Wert „missing data“ ausgegeben.
Hinweis
- Bitte beachten Sie, dass es sich bei Stundendaten um vorläufige Daten handeln kann. Dabei handelt es sich nicht zwingend um die finalen Messdaten.
- Tagesdaten stehen erst im aggregierten Zusand zur Verfügung. (Aktuelles Datum + 2 Tage)
- Ein direkter Vergleich von Stunden- und Tagesdaten ist nur bedingt möglich.
Beschreibung der XML-Daten
Wichtig
Alle Zeitangaben in den XML-Dateien sind in UTC gehalten.
Beschreibung der Datenformate
Die angeforderten Daten in der XML-Datei enthalten verschiedene Messdaten und Informationen eines Digital-Angebots. Diese Daten werden für den angegebenen Zeitraum und die Datenaggregation ausgegeben. Die Form der Ausgabe ist dabei innerhalb des Wurzelknotens <szmng>…</szmng> einheitlich gehalten und wie folgt aufgebaut:
<dim_Messdatentyp date="YYYY-MM-DD HH:MM" aggr="day"|"hour"> [<Aggregationskategorie>ABC</Aggregationskategorie>] <Messdatenzahl gesamt>X</Messdaten gesamt> [<Messdatenzahl Inland>Y</Messdaten Inland>] [<Messdatenzahl Ausland>Z</Messdaten Ausland>] </dim_Messdatentyp>
<dim_Messdatentyp>…</dim_messdatentyp>
Dieser Elementknoten gibt den Datentyp der Messdaten innerhalb dieses Knotens an.
Folgende Messdatentypen sind verfügbar:
- Agents
- Clients
- PIs (pro Code)
- Sessions
- URLs
Das Attribut {date} gibt den Zeitpunkt der innerhalb des Knotens angegebenen Messdaten an. Werden die Daten auf Stundenbasis angefordert, wird als Uhrzeit immer „00:00:00“ ausgegeben.
aggr= „day“ | „hour“
Das Attribut {aggr} gibt die Aggregation der Daten innerhalb des Knotenpunkts an. Die Aggregation ist von der Anforderung der Daten über die URL abhängig und ist für sämtliche Messdatentypen in der XML-Datei identisch.
<Aggregationskategorie>…</Aggregationskategorie>
Dieses Element ist nur bei Messdatentypen verfügbar, die neben einer Anzahl über eine weitere Kategorie aggregiert werden (Beispielsweise „PIs pro Code“). Der Kategorienname ist individuell je nach Aggregationsmerkmal (Beispiel: <code> … </code>).
[<Messdatenzahl>…</Messdatenanzahl>]
Die Messdatenanzahl wird in Form dreier Werte ausgegeben: Der Gesamtwert für den Knotenpunkt sowie Einzelwerte für „Inland“ und „Ausland“. Die Benennung des Unterelements basiert auf dem Messdatentyp. Folgendes Beispiel erhält man für die Sessions eines Tages:
<sessions>63526</sessions> (Gesamtzahl) <sessionsinland>53061</sessionsinland> <sessionsausland>10465</sessionsausland>
Messdatentypen in der XML-Datei
Die angeforderte XML-Datei enthält grundsätzlich die identischen Messdatentypen. Sollten keine Werte für den gewählten Aggregationszeitraum vorliegen, werden diese Knotenpunkte ohne Werte aufgeführt. Beispiel (keine Errors vorhanden):
<dim_errors/>
Im folgenden werden die verfügbaren Messdatentypen genauer beschrieben.
Wichtig!
Alle Zeitangaben in den XML-Dateien sind in UTC gehalten.
Hinweis
- Unter Hit verstehen wir einen vom Messsystem registrierten Request aus der SZMnG-Messung.
- Unter PI („Page Impression“) verstehen wir einen Hit der als PI-relevant eingestuft werden kann.
Unter Action verstehen wir einen Hit, der nach Auslösung eines unterstützenden Events in einer App durch das Messsystem registriert wird.
Actions können, müssen aber nicht PI-relevant sein.
- Messdatenelemente zur Aggregation über Errorcodetypen enthalten keine Unterelemente mit Teilangaben zu Zugriffen aus dem In- und Ausland (s. u.).
Agents – Anzahl Visits pro Browsertyp
Dieser Messdatentyp gibt die Anzahl von Visits pro dedizierten Browsertyp im gewählten Aggregationszeitraum aus.
Beispiel:
<dim_agents date="2017-09-20 00:00:00" aggr="day"> <agent>Chrome (Android)</agent> <sessions>2348</sessions> <sessionsinland>2005</sessionsinland> <sessionsausland>343</sessionsausland> </dim_agents>
Bezug:
Für jeden Browsertyp wird pro angefordertem Zeitraum ein separater Knotenpunkt erzeugt.
Mögliche Aggregation:
Stunden- und Tageswerte
Error – Hits pro Errorcode
Dieser Messdatentyp enthält die Hits, die im Aggregationszeitraum auf einen dedizierten Errorcodetyp anfallen. Die hier aufgeführten Hits sind zu einem großen Anteil nicht PI-relevant und können nur für Stundendaten angefordert werden.
Beispiel:
<dim_errors date="2017-09-20 19:00" aggr="hour"> <error>A1</error> <hits>1</hits> <dim_errors>
Bezug:
Pro Errorcode wird für den angeforderten Aggregationszeitraum ein Knotenpunkt erzeugt.
Mögliche Aggregation:
Stundenwerte
Events – Actions pro Eventtyp
Dieser Messdatentyp gibt die Anzahl der Aktionen im Aggregationszeitraum aus, die auf einem dedizierten Eventtyp anfallen. Der Messdatentyp wird nur für Apps gefüllt. Einige der gezählten Actions sind nicht PI-relevant. Bei Web- und MEW-Angeboten ist dieser grundsätzlich leer.
Beispiel:
<dim_events date="2017-09-12 00:00:00"aggr="day">
<event>application-enterforeground</event>
<hits>42</hits>
<hitsinland>40</hitsinland>
<hitsausland>2</hitsausland>
</dim_events>
Bezug:
Für jeden Eventtyp mit gezählten Aktionen wird ein separater Knotenpunkt je Aggregationszeitraum aufgeführt.
Mögliche Aggregation:
Stunden- und Tageswerte
PIs – PIs pro Code
Dieser Messdatentyp gibt die PIs für den angeforderten Aggregationszeitraum pro dedizierten Code aus.
Beispiel:
<dim_pis date="2017-09-20 00:00:00" aggr="day">
<code>code123456</code>
<pis>35</pis>
<pisinland>29</pisinland>
<pisausland>6</pisausland>
</dim_pis>
Bezug:
Es wird ein separater Knotenpunkt für jeden Code pro Zeitraum erstellt.
Mögliche Aggregation:
Stunden und Tageswerte
Sessions – Anzahl Visits
Dieser Messdatentyp gibt die Gesamtanzahl der Visits für den angeforderten Aggregationszeitraum aus.
Beispiel:
<dim_sessions date="2017-09-20 00:00:00" aggr="day">
<sessions>63526</sessions>
<sessionsinland>53061</sessionsinland>
<sessionsausland>10465</sessionsausland>
</dim_sessions>
Bezug:
Es wird ein separater Knotenpunkt pro angefordertem Aggregationszeitraum erzeugt.
Mögliche Aggregation:
Stunden und Tageswerte
URLs – Anzahl Hits pro URL
Dieser Messdatentyp gibt die Anzahl der PIs pro URL aus, auf die im Aggregationszeitraum Traffic eingegangen sind. Die gezählten Hits sind PI-relevant und können als vollwertige PIs betrachtet werden.
Beispiel:
<dim_urls date="2016-04-12 00:00:00" aggr="hour">
<url>www.infonline.de</url>
<hits>21</hits>
<hitsinland>20</hitsinland>
<hitsausland>1</hitsausland>
</dim_urls>
Bezug:
Pro im Aggregationszeitrum besuchter URL wird ein separater Knotenpunkt pro Zeitintervall erstellt.
Mögliche Aggregation:
Stunden und Tageswerte
Errorcodes
Die folgende Tabelle beschreibt die Errorcodes, die im Messdatenelement „Anzahl Hits pro Errorcode-Typ“ auftreten können:
| Status-/ Error-Code | Bedeutung |
| OK | No Error (Wenn kein Error (Ex) aufgetreten ist, Notifications (Nx) sind möglich) |
| N1 | Keine UUID in ae oder mi gefunden |
| N3 | UUID gefunden, ie gesetzt (App-Messung) |
| N4 | Kein i00-Cookie gesetzt |
| N5 | Cookie aufgrund niedrigerer Versionsnummer erneuert |
| N6 | Mi gefunden, ie gesetzt (Hybrid-Messung) |
| N7 | Is gefunden, ie gesetzt (iPhone-Hack) |
| N8 | Keine id gefunden, benutze hash |
| N9 | Keine id gefunden, benutze Hash und JavaScript-Fingerprint |
| N10 | Kein Zugriff auf LSO möglich |
| N11 | aid.io fehlerhaft |
| N12 | Markierung für IPv6 (Vorbereitung aif IPv6) |
| N13 | Codetyp fehlte im Aufruf, es wird dann auf CP gesetzt und der Standard-Leercode gesetzt (JS-Funktionalität) |
| N14 | Cookie defekt, wurde neu gesetzt |
| A1 | Referrer nicht in Whitelist (Datensatz in Filtered-DWH schreiben) |
| A2 | Fehler bei Clientresolving (Datensatz in Filtered-DWH schreiben) |
| A3 | Session konnte nicht aufgelöst werden |
| A4 | Prüfsumme im Datensatz stimmt nicht |
| A6 | NoScript wurde genutzt, war aber nicht aktiviert Clientresolving (Datensatz in Filtered-DWH schreiben) |
| A7 | Aufruf einer App wurde aufgrund einer IVW-Korrektur gefiltert |
| Status-/Error-Code | Bedeutung |
| A8 | Aufruf einer MEW innerhalb einer App (hybrid) wurde aufgrund einer IVW-Korrektur gefiltert |
| A9 | Aufruf einer MEW wurde aufgrund einer IVW-Korrektur gefiltert |
| A10 | Device liefert via Library Daten aus der Zukunft |
| A11 | JSON in Datensatz (ae oder mi) konnte nicht verarbeitet werden. Defektes JSON-Objekt |
| A12 | Flash-Pixel (fp) |
| A13 | Newsletter-Pixel (np) |
| A14 | Test-Pixel |
Beispiel XML-Download
Beispiel (Zeitraum):
URL: https://xml.ioam.de/xml.php?start=2017-05-07&end=2017-05-12&aggr=day
Ausschnitt aus der XML-Datei:
Beispiel (Date mit Tagesdaten):
URL: https://xml.ioam.de/xml.php?date=2017-12-12&aggr=day
Ausschnitt aus der XML-Datei:
Beispiel (Aggregation hour mit Uhrzeit):
URL: https://xml.ioam.de/xml.php?date=2017-12-12&aggr=day
Ausschnitt aus der XML-Datei:
