# Data Collected on Web Out of the box Freshpaint instruments your site and collects user actions from your site. Specifically we track the following user actions: * Pageviews * Clicks * Form Submissions * Input Field Change Events ## Properties Captured For all events we capture the following properties: | Property Name | Property | Description | | --------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Browser | `$browser` | The name of the web browser. | | Browser Version | `$browser_version` | The version of the web browser. | | Current URL | `$current_url` | The full URL of the current page. | | Device | `$device` | The device, for example `Android`, `iPhone`, or `Windows Phone` | | Device ID | `$device_id` | Randomly generated identifier stored in a cookie to identify the device on which the user performed this event. | | Host | `$host` | The domain of the current page. | | IP | `$ip` | The user's IP Address. | | OS | `$os` | The name of the operating system. | | Pageview ID | `$pageview_id` | Randomly generated identifier that changes each time the user visits a new page. | | Pathname | `$pathname` | The path of the current page. This is everything in the URL after the domain. For example if the `$current_url` is then the `$pathname` will be /pages/target-page.html. | | Screen Height | `$screen_height` | The height of the screen in pixels. | | Screen Width | `$screen_width` | The width of the screen in pixels. | | Search Engine | `$search_engine` | The search engine used before visiting your page. | | Session ID | `$session_id` | Randomly generated identifier stored in a cookie to identify the session in which this event was performed. Freshpaint considers a new session to have started after 30 minutes of inactivity. | | Time | `$time` | The time the event occurred, as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time), for example `1660750813.235`. | | Title | `$title` | The title of the page on which the event occurred. | | User Agent | `$user_agent` | The [User Agent string](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) from the device that performed this event. | | User ID | `$user_id` | Identifier for the user, for example the user's email address. See [setting-up-identify](https://documentation.freshpaint.io/readme/setting-up-identify "mention"). | ### UTM Parameters Freshpaint also captures the five [UTM parameters](https://en.wikipedia.org/wiki/UTM_parameters): | Property Name | Property | Description | | ------------- | -------------- | -------------------------------------------------------------------------------------------- | | UTM Source | `utm_source` | The site that referred the current user to your site. | | UTM Medium | `utm_medium` | How the user was linked to your site. Possible values include "social", "email" and "video". | | UTM Campaign | `utm_campaign` | The specific campaign that this user was a part of. | | UTM Term | `utm_term` | The search term used. | | UTM Content | `utm_content` | What content brought the user to your site. For example, "logolink" or "textlink". | Freshpaint also captures the initial UTM parameters listed below. These are set the very first time a user visits your site and does not change. | Property Name | Property | Description | | -------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------- | | Initial UTM Source | `initial_utm_source` | The site that referred the current user to your site for the first time. | | Initial UTM Medium | `initial_utm_medium` | How the user was linked to your site the first time. Possible values include "social", "email" and "video". | | Initial UTM Campaign | `initial_utm_campaign` | The specific campaign that this user was a part of, if applicable, the first time the user came to your site. | | Initial UTM Term | `initial_utm_term` | The search term used, if applicable, the first time the use came to your site. | | Initial UTM Content | `initial_utm_content` | What content brought the user to your site for the very first time. For example, "logolink" or "textlink". | ### Initial Referrer and Initial Referring Domain | Property Name | Property | Description | | ------------------------ | --------------------------- | -------------------------------------------------------------------------------------------- | | Initial Referrer | `$initial_referrer` | The URL of the referrer to the current page the user is on. It could possibly be `$direct` . | | Initial Referring Domain | `$initial_referring_domain` | The domain of the referrer to the current page. It could possibly be `$direct`. | Freshpaint's JavaScript SDK will track Initial Referrer and Initial Referring Domain with any event that a user completes. These properties are stored in a Freshpaint cookie the first time a user comes to your site and will not change on future site visits as long as the cookie is not cleared. For example, if a user comes to your website for the first time as a result of a search engine, like [www.google.com](http://www.google.com), the initial referrer is the URL they first came from and the initial referring domain is [www.google.com](http://www.google.com). This data is stored in a Freshpaint cookie and sent with all future events for that user. This data could help you analyze how users from different initial referrers interact with your application. #### `$direct` The Initial Referrer will be $direct when a user navigates to a site for the first time without being referred by another site. This can happen in the following scenarios: * A user types the website address directly into the address bar of the web browser * A user clicks a link that takes them directly to the website * A user clicks a bookmarked link that takes them directly to the website * Security settings in the user's browser may be preventing referrer data from being passed ### Referrer and Referring Domain | Property Name | Property | Description | | ---------------- | ------------------- | ---------------------------------------------------------------------------------------------------- | | Referrer | `$referrer` | The URL of the referrer to the current page the user is on. It could possibly be on your own domain. | | Referring Domain | `$referring_domain` | The domain of the referrer to the current page. It could possibly be your own domain. | Freshpaint's SDK will also track Referrer and Referring Domain, if it exists, with any event that a user completes. The Initial Referrer is how the user first navigates to your application. The Referrer is how the user navigated within your application to trigger the event it is associated with. For example, a user has already navigated to your website via a search engine and landed on the homepage, with the url [www.example.com/home](http://www.example.com/home). From there, they click on the "about us" link and navigate to the url [www.example.com/about](http://www.example.com/about). In this case, the Referrer would be [www.example.com/home](http://www.example.com/home) and the Referring Domain would be [www.example.com](http://www.example.com). The Initial Referring Domain, as long as the Freshpaint cookie has not been cleared, still remains [www.google.com](http://www.google.com). If a user has navigated for the first time to your site directly (see above), there will be no Referrer and Referring Domain. If the user navigated to your site directly, and then clicked on a link on your site to send them from [www.example.com/home](http://www.example.com/home) to [www.example.com/about](http://www.example.com/about), the Initial Referrer will still be `$direct` and the Referrer will be [www.example.com/home](http://www.example.com/home). ### Advertising Click Parameters Freshpaint captures the following advertising related click parameters. These power the advertising integrations by allowing you to track conversions from your ad campaigns. | External Property Name | External Property | Freshpaint Property | Relevant Documentation | | -------------------------- | ----------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Google Click ID | GCLID | $gclid | [Google Ads Documentation](https://support.google.com/google-ads/answer/9744275) | | Google iOS Click ID | GBRAID | $gbraid | [Google Ads Documentation](https://support.google.com/google-ads/answer/10417364) | | Google Web Click ID | WBRAID | $wbraid | [Google Ads Documentation](https://support.google.com/google-ads/answer/10417364) | | Google Click ID Source | GCLSRC | $gclsrc | [Google Ads Documentation](https://support.google.com/google-ads/answer/7521212) | | DoubleClick Click ID | DCLID | $dclid | [Campaign Manager 360 Documentation](https://support.google.com/searchads/answer/7342044) | | Facebook Click ID | FBCLID | $fbclid | [Meta Ads Documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc) | | Bing Click ID | MSCLKID | $msclkid | [Microsoft Ads Documentation](https://help.ads.microsoft.com/apex/index/3/en/60000) | | Twitter Click ID | TWCLID | $twclid | [X Ads Documentation](https://business.x.com/en/help/campaign-measurement-and-analytics/conversion-tracking-for-websites.html) | | Twitter Click Source | CLID\_SRC | $clid\_src | [X Ads Documentation](https://business.x.com/en/help/campaign-measurement-and-analytics/conversion-tracking-for-websites.html) | | TikTok Click ID | TTCLID | $ttclid | [TikTok Ads Documentation](https://ads.tiktok.com/help/article/tiktok-pixel) | | LinkedIn Ads Click ID | LI\_FAT\_ID | $li\_fat\_id | [LinkedIn Ads Documentation](https://www.linkedin.com/help/lms/answer/a427660) | | Reddit Ads Click ID | RDT\_CID | $rdt\_cid | [Reddit Ads Documentation](https://business.reddithelp.com/s/article/about-match-keys) | | Pinterest Click ID | EPIK | $epik | [Pinterest Ads Documentation](https://help.pinterest.com/en/business/article/pinterest-tag-parameters-and-cookies) | | Impact.com Click ID | IRCLICKID | $irclickid | [Impact.com Documentation](https://integrations.impact.com/impact-publisher/reference/click-object) | | StackAdapt Postback ID | SAPID | $sapid | [StackAdapt Documentation](https://support.stackadapt.com/hc/en-us/articles/115001063114-Conversion-Tracking) | | TheTradeDesk Impression ID | TTDIMP | $ttdimp | [The Trade Desk Documentation](https://www.thetradedesk.com/us/knowledge-base) | | Viant Click ID | VIANT\_CLID | $viant\_clid | [Viant Freshpaint Documentation](https://app.gitbook.com/o/-MA7b_ezO9UcpNU5sTg_/s/-MA7aDqsXMFbUsWVqonF/~/edit/~/changes/1405/reference/faqs/what-data-does-freshpaint-collect/autotrack/~/comments/NOJaEXEmwUfio9kG1yUI) | | Basis Auction ID | CNTR\_AUCTIONID | $cntr\_auctionId | [Basis Freshpaint Documentation](https://app.gitbook.com/o/-MA7b_ezO9UcpNU5sTg_/s/-MA7aDqsXMFbUsWVqonF/~/edit/~/changes/1405/reference/faqs/what-data-does-freshpaint-collect/autotrack/~/comments/NOJaEXEmwUfio9kG1yUI) | | Snapchat Click ID | ScCid | $sccid | [Snapchat Documentation](https://businesshelp.snapchat.com/s/article/click-id?language=en_US) | | Spotify Click ID | SPCLID | $spclid | [Spotify Documentation](https://adshelp.spotify.com/s/article/About-Spotify-Click-ID-US?language=en_US) | | Nextdoor Click ID | ndclid | $ndclid | [Nextdoor Documentation](https://docs.metarouter.io/docs/nextdoor) | | AppLovin Event ID | EVENT\_ID | $aleid | [AppLovin Documentation](https://support.axon.ai/en/growth/promoting-your-websites/tracking/tracking-url-macros/) | | Quora Click ID | qclid | $qclid | [Quora Documentation](https://quoraadsupport.zendesk.com/hc/en-us/articles/23065751885069-Conversion-API-Overview) | ### Special properties For click, form submission, and field change events Freshpaint captures the following properties: | Property Name | Property | Description | | ------------- | ---------------- | -------------------------------------------------------------------------------------------------------------- | | elements | `$elements` | The DOM hierarchy of the element interacted with. Specifically the tags, ids, and classes and some attributes. | | href | `$el_attr__href` | If the element or any parent element is a link, the URL of the page to which the link goes. | By default, Freshpaint will collect the following attributes from each DOM element: * aria-describedby * aria-label * aria-labelledby * data-auid * data-auto * data-automation * data-category * data-component * data-current-page * data-e2e * data-element * data-hook * data-index * data-key * data-page * data-qa * data-ref * data-selector * data-source-file * data-test * data-test-id * data-testid * data-tid * data-track * data-wa-link * name * role * src * href * alt * action For click events, we also capture: | Property Name | Property | Description | | ------------- | ----------------- | ----------------------------------------- | | Target Text | `$el_nested_text` | The text of the element being clicked on. | ## Opting Out of Data Collected If you want to disable autotrack for a specific element on your page, you can add the `fp-no-track` class to the element and Freshpaint will no longer track interactions with it. You may want to use `fp-no-track` if you are displaying sensitive text on your page. ## Notable Exceptions Sometimes sensitive data is typed in by the user. That’s why Freshpaint only captures when and where text is typed but not what was typed. So you'll still know when an input is being used, but not what the contents of it are. In sum, Freshpaint only captures the fact that the field was changed. Freshpaint does not capture the text the user put in the field. {% hint style="info" %} Property values are limited to 255 characters in length. Events are limited to 1MB total. {% endhint %}