Setting up Properties
Sometimes you will want to attach data to events that isn't automatically captured by autotrack. There are several ways you can attach properties to events.
You can use the techniques below to capture properties like the search term when a user performs a search, or the price of an item when a user adds it to their shopping card. Here's a table of which methods are supported by which SDKs:
Text | Web | React Native | iOS | Android |
---|---|---|---|---|
YES | no | no | no | |
YES | YES | no | no | |
YES | YES | YES | YES | |
no | YES | no | no |
Dynamic Properties enable you to collect additional metadata via Freshpaint's Autotrack beyond what's automatically collected by default. Freshpaint's Dynamic Properties can grab any visible data on the page and attach that data to your events.
Dynamic properties do not require code to setup and are the easiest way to add additional data to events.
Examples of what you can collect with Dynamic Properties:
- Collect Item Price, Item Name, and other data when a product is added to a user's cart
- Collect search terms entered by your users when they execute a search

Specify the name of the property and a CSS selector that points to the element on the page with the information you want to capture. Whenever the event is triggered, Freshpaint will look up the element with the given CSS selector and attach the text of that element as a property to the event.
You may see read-only JavaScript type properties here, created by Freshpaint support.
JavaScript Dynamic Properties allow you to specify a JavaScript function body to set the property value, with the native event available as input. They also support suppressing delivery for configured destinations on this event, via the SUPPRESS_EVENT value.
Please contact support if you'd like to learn more about this capability.
Dynamic Properties are not retroactive at this time
Data layer properties are properties given to Freshpaint that are then attached to all Freshpaint events. Data layer properties allow you to attach additional, contextual information, to your events.
You can create data layer properties by using the
addEventProperties
, addPageviewProperties
, andaddInitialEventProperties
.The
addEventProperties
function call creates a data layer property. That property will now be sent with all events going forward. As an example, you can call addEventProperties
as follows:Web
React Native
freshpaint.addEventProperties({"ab test variant": "a"});
Freshpaint.addEventProperties({"ab test variant": "a"});
The
ab test variant
property will now have the value a
until removeEventProperty
is called or addEventProperties
is called with a new value of ab test variant
. When you call addEventProperties
with a new value of ab test variant
, that value will overwrite the existing value.The
addPageviewProperties
call let's you create data layer properties that are sent until the user leaves the current page. Once the user leaves the current page, any properties created with addPageviewProperties
will now longer be sent. As an example, the call:Web
React Native
freshpaint.addPageviewProperties({"product name": "diamond ring", "price": 100});
Not supported.
will send the property
product name
with the value diamond ring
and the property price
with the value 100
as part of all events that occur on the current page. Once the user leaves the current page, the product name
and price
properties will no longer be sent. addPageviewProperties
should be used for any properties that are specific to the page the user is currently on.If you call
addPageviewProperties
you should call it as part of the Freshpaint snippet. Specifically you should call addPageviewProperties
immediately after the freshpaint.init()
call and before the call to freshpaint.page()
. This ensures any pageview properties you set are attached to the pageview event created by Freshpaint.The
addInitialEventProperties
call works like addEventProperties
except it will not override a property if that property already has a value. As an example, if you want to attach the initial page a user landed on as a property, you can do that like so:Web
React Native
freshpaint.addInitialEventProperties({"initial landing page": "/article"});
Freshpaint.addInitialEventProperties({"initial landing page": "/article"});
Now if you call
addInitialEventProperties
again with a different value of initial landing page
, the property initial landing page
will still be set to /article
.To remove a data layer property, you can call the
removeEventProperty
api method. The callWeb
React Native
freshpaint.removeEventProperty("pricing plan");
Freshpaint.removeEventProperty("pricing plan");
will stop sending the property
pricing plan
going forward.If you send an event into Freshpaint with a manual track call, you can pass in a map of properties as the second argument:
Web
React Native
iOS Swift
iOS Objective-C
Android
freshpaint.track("Purchase", {"price": 500});
Freshpaint.track("Purchase", {"price": 500});
Freshpaint.shared().track(
"Purchase",
properties: ["price": 500]
)
[[FPAnalytics sharedAnalytics]
track:@"Purchase"
properties:@{ @"price": @500 }];
Freshpaint
.with(getActivity().getApplicationContext())
.track("Purchase", new Properties().putValue("price", 500));
For React Native, Freshpaint will automatically capture a whitelist of properties from your React components. For a complete list of properties collected by Freshpaint, see the docs on what information is collected by the React Native SDK. You can also whitelist your own properties. You can use these properties to narrow down event definitions when defining events. For example, Freshpaint captures the
title
property of React Native buttons, allowing you to define a CSS selector like so:Button[title="Press Here"]
To whitelist your own properties, attach a
freshpaintOptions
argument to the component class with the attributes you would like to whitelist or blacklist. For example, if you have a functional component like:function MyComponent({ arg }) {
...
}
You can capture the
arg
property by adding the following bit of code:MyComponent.freshpaintOptions = {
eventProps: {
include: ['arg'],
}
};
If you are using a class component, you instead set the
freshpaintOptions
property of the class like so:class MyComponent extends Component {
freshpaintOptions = {
eventProps: {
include: ['arg'],
}
};
}
Last modified 1mo ago