1. Home
  2. Data Services
  3. REST-Report API
  4. Dimensions- & Kennzahlenfilter

Dimensions- & Kennzahlenfilter

Dimensionsfilter

In etracker Analytics können die Datensätze eines Reports auf Basis eines gewünschten Wertes innerhalb einer aktivierten Dimension gefiltert werden. Der Parameter attributeFilter, der jedoch nur auf Segmente und Dimensionen angewendet werden kann, erlaubt es, die Daten eines Reports auch mittels REST API gefiltert abzurufen. Der Aufbau ist wie folgt:

ParameterattributeFilter
BeschreibungEnthält die Filtereigenschaften in Form eines JSONArrays.
Aufbau JSONArray[
{
"input":"SUCHBEGRIFF",
"type":"contains",
"attributeId":"ATTRIBUT_ID",
"filterType":"simple"
}
]
Beschreibung JSONArray• input: Enthält den substring, der in der Dimension bzw. in dem Segment enthalten sein soll.
• attributId: Dimension bzw. Segment, welche(s) gefiltert werden soll.
• type und filterType sind nicht anzupassen
Erlaubte ZeichenFür input sind die folgenden Zeichen erlaubt:
• Sämtliche Buchstaben sämtlicher Sprachen, die im Unicode enthalten sind
• alle Ziffern: 0 - 9
• Sonderzeichen: § % $ ( ) = ? € @ , . ! & + - ^ ° _ | [ ] / * { } : \
• Leerzeichen

Hinweis:
Die korrekte Nutzung erfordert eine URL-Encodierung des JSONArrays.

URL-encodiertes Beispiel:
%5B%7B%22input%22%3A%22SUCHBEGRIFF%22%2C%22type%22%3A%22contains%22%2C%22attributeId%22%3A%22ATTRIBUT_ID%22%2C%22filterType%22%3A%22simple%22%7D%5D

Das nachfolgende Beispiel veranschaulicht die Nutzung des Parameters in einer Abfrage:

https://ws.etracker.com/api/v6/report/EAPage/data?startDate=2016-11-29&endDate=2016-12-06&displayType=grouped&twig=fold%3A&attributes=page_name&sortColumn=unique_visits&sortOrder=1&attributeFilter=%5B%7B%22input%22%3A%22homepage%22%2C%22type%22%3A%22contains%22%2C%22attributeId%22%3A%22page_name%22%2C%22filterType%22%3A%22simple%22%7D%5D

Soll innerhalb von mehreren Dimensionen oder Segmenten gefiltert werden, sind die weiteren Einträge dem JSONArray entsprechend hinzuzufügen:

[
{
"input":"SUCHBEGRIFF",
"type":"contains",
"attributeId":"ATTRIBUT_ID",
"filterType":"simple"
},
{
"input":"SUCHBEGRIFF",
"type":"contains",
"attributeId":"ATTRIBUT_ID",
"filterType":"simple"
},
{
"input":"SUCHBEGRIFF",
"type":"contains",
"attributeId":"ATTRIBUT_ID",
"filterType":"simple"
}
]

Kennzahlenfilter

Analog zum Dimensionsfilter können die Daten eines Reports auch auf Basis einer Kennzahl gefiltert über die REST API abgerufen werden. Die Filtereigenschaften können für eine Kennzahl mit Hilfe des Parameters „keyFigureFilter“ gesetzt werden:

ParameterkeyfigureFilter
BeschreibungEnthält die Filtereigenschaften in Form eines JSONArrays
Aufbau JSONArray[
{
"input":100,
"type":"lt",
"filter":"include",
"keyfigure":"unique_visits"
}
]
Beschreibung JSONArray• input: Enthält den „Integer Wert“, der auf die Kennzahl als Filter angewendet werden soll.
• type: erlaubt sind "lt" = lower than, "gt" = greater than oder "eq" = equal
• filter: include oder exclude
• keyfigure: Kennzahlen-ID
Erlaubte ZeichenFür „input“ ist nur die Menge der natürlichen Zahlen zulässig

Hinweis: Die korrekte Nutzung erfordert, wie auch beim Dimensionsfilter, eine URL-Encodierung des JSONArrays.

Beispiel:

%5B%7B%22input%22%3A100%2C%22type%22%3A%22lt%22%2C%22filter%22%3A%22include%22%2C%22keyfigure%22%3A%22unique_visits%22%7D%5D

Beispiel für die Verwendung des Parameters in einer Abfrage:

https://ws.etracker.com/api/v6/report/EAPage/data?startDate=2018-03-06&endDate=2018-03-12&displayType=grouped&twig=fold%3A&attributes=page_name&sortColumn=unique_visits&sortOrder=1&attributeFilter=&keyfigureFilter=%5B%7B%22input%22%3A100%2C%22type%22%3A%22lt%22%2C%22filter%22%3A%22include%22%2C%22keyfigure%22%3A%22unique_visits%22%7D%5D&limit=101&requestSource=apollo_application

Soll auf mehreren Kennzahlen ein Filter angewendet werden, so ist das JSONArray entsprechend zu erweitern:

[{"input":int, "type":"lt"|"gt"|"eq", "filter":"include", "keyfigure":"Kennzahlen-ID"}]

Nachfolgend ein Beispiel für mehrere Kennzahlenfilter (decodiert):

http://ws.etracker.com/api/v6/report/EAPage/data?startDate=2018-03-07&endDate=2018-03-13&displayType=grouped&twig=fold:&attributes=page_name&sortColumn=unique_visits&sortOrder=1&attributeFilter=&keyfigureFilter=[{„input“:13,“type“:“lt“,“filter“:“include“,“keyfigure“:“unique_visitors“},{„input“:23,“type“:“eq“,“filter“:“include“,“keyfigure“:“page_impressions“}]&limit=101&requestSource=apollo_application

Ebenfalls ist es möglich, für einen Kennzahlenfilter eine Ober- und Untergrenze zu definieren:

http://ws.etracker.com/api/v6/report/EAPage/data?startDate=2018-03-07&endDate=2018-03-13&displayType=grouped&twig=fold:&attributes=page_name&sortColumn=unique_visits&sortOrder=1&attributeFilter=&keyfigureFilter=[{„input“:13,“type“:“gt“,“filter“:“include“,“keyfigure“:“unique_visitors“},{„input“:50,“type“:“lt“,“filter“:“include“,“keyfigure“:“unique_visitors“}]&limit=101&requestSource=apollo_application