Freshpaint React Native SDK Reference

track

The track call can be used to manually send data to your destinations. See the docs on manually tracking events in Freshpaint for more information.

Freshpaint.track("Purchase", {"price": 500});

Argument	Type	Required	Description
Event Name	String	Yes	The name of the event you want to send to Freshpaint.
Properties	Object	No	A JSON object of properties you want to send along with the event.

identify

The identify call can used to attach user properties the current user. Destinations will then use that data to create a single profile for that user, even if data for that user comes from multiple places. See the identify docs for more information.

// Associate all future events sent from
// the library with the distinct_id [e-mail]
Freshpaint.identify("[e-mail]", { 
  "email": "[e-mail]", 
  "name": "Ada Lovelace"
});‌

The properties argument is optional. If you want to only attach a unique identifier to the user, you can call identify like so:

Freshpaint.identify("[e-mail]");

Likewise, the identifier is also optional. If you only want to attach properties to the user without attaching an identifier, you can perform a call like the following:

Freshpaint.identify({ 
  "email": "[e-mail]", 
  "name": "Ada Lovelace"
});

Argument	Type	Required	Description
unique_id	String	No	A string that uniquely identifies a user (such as email address).
properties	Object	No	A JSON object of user properties to send to the destinations.

group

The group call will add the given user to a group and attach the provided properties to the group. The call

freshpaint.group("Google", {
  "plan": "enterprise",
  "sign-up-date": "04/01/2019"
});

will add the current user to the "Google" group and attach the provided properties to the group.

Argument	Type	Required	Description
unique_id	String	Yes	The ID of the group the user is being added to.
properties	Object	No	Properties to attach to the group.

reset

The reset call clears any local Freshpaint data attached to this user. This does not clear any local data for any of your destinations.

Freshpaint.reset();

addEventProperties

The addEventProperties call can be used to set data layer properties. Once a property is set through addEventProperties all events going forward will contain that property. The call

Freshpaint.addEventProperties({"pricing plan": "enterprise"});

will include the property pricing plan with the value enterprise until either the value is overwritten or you delete the property with removeEventProperty. addEventProperties should be used to set any properties that can change.

Argument	Type	Required	Description
properties	Object	Yes	An object of properties and values to attach to all events going forward.

addInitialEventProperties

The addInitialEventProperties call works the same way as addEventProperties except if a property is already set, addInitialEventProperties will not override it. This is useful for when you care about the first value of some property. As an example, the call

Freshpaint.addInitialEventProperties({"initial landing page": "/article"});

will set the value of the property initial landing page to /article. Even after calling addInitialEventProperties with a different of initial landing page the value of initial landing page will still be /article. addInitialEventProperties should be used to set properties that you never want to change.

Argument	Type	Required	Description
properties	Object	Yes	An object of properties and values to attach to all events going forward.

removeEventProperty

The removeEventProperty call can be used to remove data layer properties. Once used, freshpaint will no longer send the given property. As an example, the call:

Freshpaint.removeEventProperty('search term');

will delete the current search term property and Freshpaint will stop sending it going forward.

Argument	Type	Required	Description
property	String	Yes	The name of the property to remove.

setOptOut

The setOptOut call can be used to opt the current user out of tracking.

Freshpaint.setOptOut(true)

Argument	Type	Required	Description
property	Boolean	No	True or false to disable tracking for the current user.

init

Freshpaint's React Native SDK accepts some options in its init method. We'll go over these options in this section.

While there are technically other init options that may be available, options not documented below are unsupported and may not work as intended. Use them at your own risk, and please contact [e-mail] if there is a specific option you would like added supported for.

Option	Type	Default	Description
sessionTimeout	number	1800000 ms (30 minutes)	The timeout for Freshpaint to start a new session, in seconds. If more than sessionTimeout seconds have passed since the last event was registered in an existing session, Freshpaint will start a new session and generate a new session_id.
optOut	boolean	false	If true then Freshpaint will not send or log events.