etracker
Analytics Editions / Pricing Live-Demo
etracker
Optimiser Editions / Pricing Live-Demo
Pricing For Agencies Support

Dimension Filter

In etracker Analytics, the data records of a report can be filtered based on the desired value within an activated dimension. The parameter attributeFilter, which can only be applied to segments and dimensions, allows the data of a report to be called filtered using the REST API. The structure is as follows:

ParameterattributeFilter
DescriptionIncludes the filter characteristics in the form of a JSON array.
JSON array structure[
{
"input":"SUCHBEGRIFF",
"type":"contains",
"attributeId":"ATTRIBUT_ID",
"filterType":"simple"
}
]
JSON array description• input: Contains the substring which needs to be included in the dimension or segment.
• attributId: Dimension or segment which should be filtered.
• type and filterType do not need to be adapted
Permitted charactersThe following characters are permitted for input:
• Additional letters from all languages which are included in unicode
• all numbers: 0 - 9
• special characters: § % $ ( ) = ? € @ , . ! & + - ^ ° _ | [ ] / * { } : \
• space
Note:
Correct usage requires URL encoding of the JSON array.
URL-encoded example:
%5B%7B%22input%22%3A%22KEYWORD%22%2C%22type%22%3A%22contains%22%2C%22attributeId%22%3A%22ATTRIBUT_ID%22%2C%22filterType%22%3A%22simple%22%7D%5D

The following example demonstrates the use of the parameter in a query:

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

If multiple dimensions or segments inside a display are to be filtered, the additional entries are to be added to the JSON array accordingly.

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

Need help?
Our friendly, knowledgeable support engineers are here for you.