Einschränkung von Attributen & Kennzahlen
Die etracker REST-API bietet neben den Basis-Parametern auch weitere Parameter, um die Rückgabe-Tabelle genauer zu spezifizieren. Unter Verwendung der Basis-Parameter werden Attributwertkombinationen immer mit Werten aus allen vorhandenen Attributen gebildet. Meist interessieren aber nur Kombinationen aus einem Teil der vorhandenen Attribute. Zudem sind nicht immer alle Kennzahlen für alle Analysen notwendig.
Es ist auch möglich, bestimmte Attributwerte mithilfe von Attributwert-Ids zu fixieren oder zu ignorieren. Dann werden nur die Attributwertkombinationen zurückgegeben, die die fixierten Attributwerte enthalten bzw. die ignorierten Attributwerten nicht enthalten.
Mit den folgenden beiden Parametern können die Attribute und Kennzahlen eingeschränkt werden.
| Parameter | Attributes |
|---|---|
| Beschreibung | Es werden Attributwertkombinationen nur aus den angegebenen Attributen gebildet. Die Werte in den Rückgabe-Zeilen erscheinen in der angegebenen Reihenfolge. Falls Wert-Filter angegeben werden, werden nur die Attributwertkombinationen gebildet, die die fixierten Werte enthalten oder die ignorierten Werte nicht enthalten. |
| Zulässige Werte | Im einfachsten Fall eine mit Kommas getrennte Liste von Attribut-Ids. Die Ids können den Metadaten des Reports entnommen werden. Hinter jeder Attribut-Id kann eine mit Semikolons getrennte Liste von Attributwert-Ids in Klammern angegeben werden. Die Attributwert-Ids können dem ersten Eintrag in den Tabellen-Zeilen entnommen werden. Ein Minuszeichen darf vor jeder Attibutwert-Id hinzugefügt werden, um alle Attributwert-Ids in der Liste zu ignorieren. |
| Beispiele | Einfacher Fall: 'device_type,geo_country,geo_region' Attributwerte werden für device_type fixiert: 'device_type(3257;2269),geo_country,geo_region' Attributwerte werden für device_type fixiert und geo_country ignoriert: 'device_type(3257;2269),geo_country(-10;-324),geo_region' |
| Parameter | Figures |
|---|---|
| Beschreibung | Es werden nur die angegebenen Kennzahlen berechnet und zurückgegeben. Die Werte in den Rückgabe-Zeilen erscheinen in der angegebenen Reihenfolge. |
| Zulässige Werte | Komma-separierte Liste von Kennzahl-Ids. Die Ids können den Metadaten des Reports entnommen werden. Falls eine Kennzahl zum Sortieren angegeben wurde (siehe sortColumn), muss die Kennzahl in der Liste enthalten sein. |
| Beispiel | 'unique_visitors,page_impressions,pi_per_visit' |
Die folgende Abfrage verdeutlicht die Nutzung des Parameters ‚attributes‘.
https://ws.etracker.com/api/v6/report/EADeviceType/data?startDate=2021-01-01&endDate=2021-01-31&sortColumn=unique_visits&sortOrder=1&offset=0& limit=10&attributes=device_type(137),geo_country,geo_region
Die Parameter wurden wie folgt gesetzt:
- startDate = 2021-01-01
- endDate = 2021-01-31
- sortColumn = unique_visits (Besuche)
- sortOrder = 1 (absteigend)
- offset = 0
- limit = 10
- attributes=device_type(137),geo_country,geo_region
Der Attributwert ‚Desktop‘ hat die ID 137. Die Abfrage gibt also nur die Attributwertkombinationen der Attribute Gerätetyp, Land und Region zurück, für die der Gerätetyp ‚Desktop‘ war. Es werden auch nur Daten von Januar 2021 berücksichtigt und die Zeilen werden nach ‚Besuche‘ sortiert, bevor sie zurückgegeben werden. Nur die ersten 10 Zeilen (und die Zeile ‚Gesamt‘) werden zurückgegeben.
Der Attributwert ‚Germany‘ hat die ID 1086 und der Attributwert ‚Austria‘ hat die ID 1092. Um diese beiden Attributwerte zu ignorieren, kann die Abfrage wie folgt abgeändert werden:
https://ws.etracker.com/api/v6/report/EADeviceType/data?startDate=2021-01-01&endDate=2021-01-31&sortColumn=unique_visits&sortOrder=1&offset=0&limit=10&attributes=device_type(137),geo_country(-1086;-1092),geo_region
Damit werden nur Attributwertkombinationen gebildet, die ‚Desktop‘ enthalten und ‚Germany‘ und ‚Austria‘ nicht enthalten. Alle anderen Vorgaben sind gleichgeblieben.
Bisher wurden alle Kennzahlen ausgegeben. In der folgenden Abfrage werden sie eingeschränkt:
https://ws.etracker.com/api/v6/report/EADeviceType/data?startDate=2021-01-01&endDate=2021-01-31&sortColumn=unique_visits&sortOrder=1&offset=0&limit=10&attributes=device_type(137),geo_country(-1086;-1092),geo_region&figures=unique_visits,page_impressions,pi_per_visit
Der Parameter ‚figures‘ wurde hinzugefügt:
- figures=unique_visits,page_impressions,pi_per_visit
Damit werden nur die Werte der drei genannten Kennzahlen berechnet und in der angegebenen Reihenfolge ausgegeben. Da die Kennzahl ‚unique_visits‘ zum Sortieren benutzt wurde, muss sie in der Liste enthalten sein.
Hinweis:
Es können pro Abfrage maximal 20 Segmente angesetzt werden.