Im Folgenden werden die Basis-Parameter der Report API beschrieben. Es folgen dann Beispiele zur Erläuterung der Parameter.
Parameter | Limit |
---|---|
Beschreibung | Gibt die maximale Anzahl an Datensätzen an. die zzgl. der Summenzeile zurückgegeben werden sollen |
Zulässige Werte | Ganze Zahlen |
Beispiele | 10, 100 oder 5000 |
Parameter | Offset |
---|---|
Beschreibung | Gibt des Startpunkt bzw. den Datensatz unmittelbar vor dem ersten Rückgabedatensatz der Abfrage an |
Zuläsige Werte | ganze Zahlen |
Beispiele | 0, 10 oder 100 |
Parameter | startDate |
---|---|
Beschreibung | Nur Daten, die ab 00:00 Uhr am angegebenen Datum erfasst wurden, sollen für die Abfrage berücksichtigt werden |
Zulässige Werte | Gültige Datumsangaben der Form JJJJ-MM-TT |
Beispiele | 2016-01-23 oder 2012-10-31 |
Parameter | endDate |
---|---|
Beschreibung | Nur Daten bis 23:59 Uhr am angegebenen Datum sollen erfasst und für die Abfrage berücksichtigt werden |
Zulässige Werte | Gültige Datumsangaben der Form JJJJ-MM-TT |
Beispiele | 2016-01-30 oder 2014-12-17 |
Parameter | sortColumn |
---|---|
Beschreibung | Die dAten sollen vor der Rückgabe nach den Werten der angegebenen Spalte sortiert werden |
Zulässige Werte | Gültige Ids von sortierbaren Spalten. Die Ids und die Sortierbarkeit sind in den Metadaten eines Reports zu finden |
Beispiele | unique visits oder pi per visit |
Parameter | sortOrder |
---|---|
Beschreibung | Gibt die Richtung der Sortierung an (auf- oder absteigend) |
Zulässige Werte | 1 für absteigend, 2 für aufsteigend |
Die folgende Abfrage verwendet die obigen Parameter, um gezielter bei der Abfrage des Reports ‚Geräte‘ vorzugehen.
https://ws.etracker.com/api/v6/report/EADeviceType/data?startDate=2016-01-01&endDate=2016-01-31&sortColumn=unique_visits&sortOrder=1&offset=0&limit=10
Die Parameter wurden wie folgt gesetzt:
Damit werden die in Januar 2016 erfassten Daten nach der Kennzahlspalte ‚Besuche‘ absteigend sortiert und die ersten 10 Zeilen zusammen mit der Zeile ‚Gesamt‘ zurückgegeben. Falls weitere Daten erwünscht sind, können offset und limit progressiv erhöht werden, bis keine Daten mehr zurückgegeben werden. Die nächsten 10 Datensätzen wurden z. B. wie folgt abgefragt:
https://ws.etracker.com/api/v6/report/32005/data?startDate=2016-01-01&endDate=2016-01-31&sortColumn=unique_visits&sortOrder=1&offset=10&limit=10
Ellen Buthe
Senior Product
Manager