Einleitung
Die Reporting API bietet neben der bereits vorhandenen SOAP-Schnittstelle die Möglichkeit, Statistik-, Tracking- und Scoring-Daten zu beziehen. Diese können dann z. B. in Business Intelligence Lösungen und Dashboards eingebunden, ausgewertet und visualisiert werden.
Authentifizierung
Die Authentifizierung erfolgt über HTTP Basic Auth (externer Link).
Sicherheit
Der Zugriff auf die API ist ausschließlich über HTTPS möglich und erfordert das Recht Reporting API. Zusätzlich werden noch tabellenspezifische Rechte benötigt, welche bei den Tabellen beschrieben werden.
URL-Parameter
Ein Request der Reporting API erfolgt über die Login Domain. Die Login Domain ist davon abhängig, auf welcher Instanz sich Ihr Account befindet. Die Login Domain kann z.B. folgendermaßen lauten:
- scnem.com
- scnem2.com
- scnem3.com
Der Request kann somit z.B. an die folgende URL erfolgen:
https://scnem2.com/report.php?pool_id=<POOL_ID>&format=<FORMAT>
Um sicherzustellen, dass der richtige User verwendet wird, empfehlen wir den Usernamen voranzustellen:
https://USERNAME@scnem2.com/report.php?pool_id=<POOL_ID>&format=<FORMAT>
Für den Request stehen folgende Parameter zur Verfügung:
- pool_id
- format (Pflicht)
- customer_id
- table
- lang
- time_format
- from
- to
Ausgabeformat von Datums- und Zeitangaben
Datums- und Zeitangaben werden standardmäßig im Format iso8501 (z.B.: 2014-05-16T15:52:01+00:00) ausgegeben. Über den Parameter time_format kann dieses Format beeinflusst werden.
time_format=<time_format>
mögliche Formate sind:
| Parameterwert | Beispiel | Beschreibung |
|---|---|---|
| iso8601 | 2014-08-15T15:52:01+00:00 | Standardformat |
| unix | 1124121121 | Unix Timestamp |
Zeitliche Einschränkung von Abfragen
Die Parameter from und to dienen der zeitlichen Einschränkung von Abfrageergebnissen.
from=<date string> (Default ist jetzt minus 24 Stunden) to=<date_string> (Default = Zeitpunkt der Abfrage) Als Werte können sowohl absolute Datums bzw. Zeitangaben (z.B.: yesterday, last monday, now-24hours, etc) verwendet werden.
Möglich bei:
table=profiles
table=newslettersendlogs
table=scoringhistory
table=trackinghistory
table=mailings
Ausgabe-Formate (format)
Der Parameter "format" in der URL definiert das gewünschte Ausgabeformat der angeforderten Daten.
format=<format> (Pflichtangabe)
Verfügbare Formate:
| Parameterwert | Beschreibung | MIME Type |
|---|---|---|
| xml | XML Repräsentation der Daten | application/xml |
| json oder jsonarray | Repräsentation der Daten als Liste von json | application/json |
| jsonobject | Repräsentation der Daten als einzelnes json Objekt | application/json |
| csv | CSV Repräsentation der Daten | text/csv |
Ausgabesprache
Die Ausgabesprache wirkt sich auf die Spalte "name" der Tabelle "resourcetypes", sowie die Tabelle "profiles" (bspw. die Werte der Spalten, SALUTATION, COUNTRY, etc.) aus.
lang=<lang>
Verfügbare Sprachen:
| Parameter-Wert | Beschreibung |
|---|---|
| en | Englisch (Standard) |
| de | Deutsch |
| it | Italienisch |
| fr | Französisch |