--- title: "Get global tracker settings" method: GET path: "/api/tracker/v2/settings/app/global" tags: ["Tracker Settings"] --- # Get global tracker settings `GET /api/tracker/v2/settings/app/global` ## Request - Base URL: `https://example.piwik.pro` - URL: `https://example.piwik.pro/api/tracker/v2/settings/app/global` - Auth: OAuth 2 - Client credentials - Token URL: `/auth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) It gets global tracker settings. ## Response `200` OK - object - `data` object, required - `type` 'tracker/settings/app/global', required - `id` 'global', required - `attributes` object, required - `anonymize_visitor_geolocation_level` 'none' | 'City' | 'Region' | 'Country' | 'Continent': When enabled, some geolocation data will be removed from the events an session. For example, if you set to remove data at country level, the geolocation match will be as accurate as possible, but City and Region data will be removed in the process. Country and Continent data will be accurate. This transformed data will be used in aggregation. ``` Initial global value: none ``` - `anonymize_visitor_ip_level` 0 | 1 | 2 | 3 | 4: Anonymize "n" octets of Visitors IP addresses. All events and sessions that are processed will have ther IP transformed. For example, when you anonymize 2 last octetsm incoming IP 10.76.143.250 will be trasformed to 10.76.0.0. Such transformed IP will be used to aggregate data. ``` Initial global value: 0 ``` - `campaign_content_params` string[]: URL query parameters that could contain content of the campaign. Processor will search for the paramters listed in this setting and it will set dimension ``campaign_content`` to the first parameter that matches name. ``` Initial global value: [ pk_content, utm_content ] ``` - `campaign_id_params` string[]: URL query parameters that could contain an ID of the campaign. Processor will search for the paramters listed in this setting and it will set dimension ``campaign_id`` to the first parameter that matches name. ``` Initial global value: [ pk_cid, utm_id ] ``` - `campaign_keyword_params` string[]: URL query parameters that could contain keywords for the campaign. Processor will search for the paramters listed in this setting and it will set dimension ``campaign_keyword`` to the first parameter that matches name. ``` Initial global value: [ pk_medium, utm_medium ] ``` - `campaign_medium_params` string[]: URL query parameters that could contain mediums for the campaign. Processor will search for the paramters listed in this setting and it will set dimension ``campaign_medium`` to the first parameter that matches name. ``` Initial global value: [ pk_medium, utm_medium ] ``` - `campaign_name_params` string[]: URL query parameters that could contain name of the campaign. Processor will search for the paramters listed in this setting and it will set dimension ``campaign_name`` to the first parameter that matches name. ``` Initial global value: [ pk_campaign, piwik_campaign, pk_cpn, utm_campaign ] ``` - `campaign_source_params` string[]: URL query parameters that could contain sources for the campaign. Processor will search for the paramters listed in this setting and it will set dimension ``campaign_source`` to the first parameter that matches name. ``` Initial global value: [ pk_source, utm_source ] ``` - `create_new_visit_when_campaign_changes` boolean: When enabled, a new session is created each time when campaign type or name changes during the session, even if the `visit_standard_length` did not expire. ``` Initial global value: false ``` - `create_new_visit_when_website_referrer_changes` boolean: When enabled, a new session is created each time when refferrer type or name changes during the session, even if the `visit_standard_length` did not expire. ``` Initial global value: false ``` - `enable_fingerprinting_across_websites` boolean: When this option is enabled tracker will try to generate unified visitor_id even when user visits different websites. ``` Initial global value: false ``` - `set_ip_tracking` boolean: When disabled, JSTC will set `setIpTracking` to `false` and with each tracking request an additional `rmip=1` parameter will be sent. With `rmip=1` query parameter sent to Tracker, tracker will remove all IP information from tracking request on early stage of request processing. IP address will not be stored anywhere, even in raw tracking request database (table `log`). ``` Initial global value for a new organization: true ``` - `exclude_crawlers` boolean: When disabled, crawler bots will be tracked like the regular visitors. ``` Initial global value: true ``` - `exclude_unknown_urls` boolean: When enabled, tracker discards all requests originating from urls absent in `urls` collection ``` Initial global value: false ``` - `excluded_ips` string[]: List of IPs to blacklist from tracking. You can use wildcards, e.g. ``1.2.3.*`` or ``1.2.*.*`` ``` Initial global value: [] ``` - `excluded_user_agents` string[]: If the visitor's user agent string contains any of the strings you specify, the visitor will be excluded from tracking. ``` Initial global value: [] ``` - `fingerprint_based_on_anonymized_ip` boolean: When enabled, visitor geolocation calculation is based on anonymized IP instead of real one. ``` Initial global value: false ``` - `keep_url_fragment` boolean: When disabled, everything after #, e.g. ``example.org/index.html#first_section`` will be tracked as ``example.org.index.html`` ``` Initial global value: true ``` - `session_limit_exceeded_action` 'split_and_exclude' | 'just_split': Defines how tracker will behave when user session exceeds its limits, either time or event count. Defined behaviours are `split_and_exclude` - session will be splitted (ended) and all further events that would fit into this session will be excluded, `just_split` - session will be splitted into new one with the event which exceeded its limit. ``` Initial global value: split_and_exclude ``` - `session_max_duration_seconds` integer: Limits the session in term of time. The session can last only for defined time period, after which it will be splitted into new session. Max period is 12h and it result from session detection mechanism in PSA. ``` Initial global value: 43200 ``` - `session_max_event_count` integer: Limits the session in term of evens count. Thes session can contain only this much events, after reaching higher count it will be splitted into new session. Max is 65535, which is unlikely to reach by a human. ``` Initial global value: 5000 ``` - `site_search_category_params` string[]: URL query parameters that are used for site search category in an app. If you want to have this parameters removed from URLs in reports enable ``strip_site_search_query_parameters`` setting. ``` Initial global value: [] ``` - `site_search_query_params` string[]: URL query parameters that are used for site search in an app. If you want to have this parameters removed from URLs in reports enable ``strip_site_search_query_parameters`` setting. ``` Initial global value: [ q, query, s, search, searchword, keyword ] ``` - `strip_site_search_query_parameters` boolean: When enabled, all of parameters set in `site_search_query_params` and `site_search_category_params` will be removed from report URLs. ``` Initial global value: false ``` - `tracking_fingerprint_disabled` boolean: Enabling this, will make tracker to use fingerprint from cookie. If you want to use this setting make sure to enable `trust_visitors_cookies`. ``` Initial global value: false ``` - `trust_visitors_cookies` boolean: DEPRECATED! Use `use_session_hash` / `use_anonymous_session_hash` instead. When enabled, session events wont be matched by a device fingerprint. Only vistor side generated `_id` paramater will be taken into account. ``` Initial global value: false ``` - `use_session_hash` boolean: When enabled, session events that are tracked non-anonymously will be matched by a Session Hash. When disabled only vistor side generated `_id` paramater will be taken into account. ``` Initial global value: true ``` - `use_anonymous_session_hash` boolean: When enabled, session events that are tracked anonymously will be matched by a Session Hash. When disabled only vistor side generated `_id` paramater will be taken into account. ``` Initial global value: true ``` - `url_query_parameter_to_exclude_from_url` string[]: URL query parameters excluded from tracking, like: ``gclid``, ``fb_xd_fragment``, ``fb_comment_id``. Regular expressions such as ``/^sess.*|.*[dD]ate$/`` are supported. ``` Initial global value: [ gclid, fbclid, fb_xd_fragment, fb_comment_id, phpsessid, jsessionid, sessionid, aspsessionid, doing_wp_cron, sid, pk_vid ] ``` - `updated_at` string, date-time: Timestamp of object's last modification ## Other responses - `401`: Unauthorized - `403`: Forbidden ## Changes - **2026-11-03** `8b8abe1ab4f1`: 1 info - endpoint added [Operation history](https://skmtc.dev/piwik/apis/web-api/changes/api/tracker/v2/settings/app/global/get.md) --- [API](https://skmtc.dev/piwik/apis/web-api.md) - [All operations](https://skmtc.dev/piwik/apis/web-api/llms.txt) - [OpenAPI document](https://skmtc.dev/piwik/apis/web-api/revisions/8b8abe1ab4f1?raw)