Restriction of Attributes & Key Figures
Along with the basic parameters, the etracker REST API also provides additional parameters in order to more precisely specify the return table. Using the basic parameters, attribute value combinations will always be made up of values from all available attributes. Usually, only combinations from one section of the existing attributes are of interest. Furthermore, not all key figures are required for certain analyses.
It is also possible to fix or ignore certain attribute values with the help of the attribute IDs. Then only those attribute value combinations will be returned which contain the fixed attribute values or which do not contain the ignored attribute values.
Use the following two parameters to limit the attributes and key figures.
| Parameter | Attributes |
|---|---|
| Description | Attribute value combinations will only be formed from the entered attributes. The values in the return lines appear in the order given. If value filters are given, only those attribute value combinations will be formed which either contain the fixed values or do not contain the ignored values. |
| Allowed values | In the simplest of cases, a comma-separated list of attribute IDs. The IDs can be found in the metadata of the report. A semicolon-separated list of attribute value IDs can be entered in brackets behind each attribute ID. The attribute value ID can be found in the first entry in the table lines. A minus symbol can be prefixed to each attribute value ID so as to ignore all attribute value IDs in the list. |
| Examples | Simple case: 'device_type,geo_country,geo_region' Attribute values are fixed for device_type: 'device_type(3257;2269),geo_country,geo_region' Attribute values are fixed for device_type and geo_country ignored: 'device_type(3257;2269),geo_country(-10;-324),geo_region' |
| Parameter | Figures |
|---|---|
| Description | Only the key figures entered will be calculated and returned. The values in the return lines appear in the order given. |
| Allowed values | Comma-separated list of key figure IDs. The IDs can be found in the metadata of the report. In case a key figure was entered for sorting purposes (see sortColumn), then the key figure must be contained in the list. |
| Example | 'unique_visitors,page_impressions,pi_per_visit' |
The following query clarifies the use of the ‘attributes’ parameter.
https://ws.etracker.com/api/v6/report/CCWRDeviceType/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
The parameters were set as follows:
- 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
The attribute value ‘Desktop’ has the ID 137. The query only returns the attribute value combinations of the attributes Device Type, Country and Region for which the device type was ‘Desktop’. Only data from January 2021 will be considered and the lines will be sorted by ‘Visits’ before being returned. Only the first 10 lines (and the ‘Total’ line) will be returned.
The attribute value ‘Germany’ has the ID 1086 and the attribute value ‘Austria’ has the ID 1092. In order to ignore these two attribute values, the query can be modified as follows:
https://ws.etracker.com/api/v6/report/CCWRDeviceType/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
This will only form attribute value combinations which contain ‘Desktop’ and which do not contain ‘Germany’ or ‘Austria’. All other specifications remain the same.
To date, all key figures were issued. In the following query, they are limited:
https://ws.etracker.com/api/v6/report/CCWRDeviceType/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
The ‘figures’ parameter was added:
- figures=unique_visits,page_impressions,pi_per_visit
This only calculates the values of the three named key figures and issues them in the order given. Since the ‘unique_visits’ key figure was used for sorting, it needs to be contained in the list.
Note:
A maximum of 20 segments can be set per query.