Amplitude Reference
Amplitude is a leading Product Analytics tool. After sending Freshpaint data to Amplitude, teams can harness the power of product analytics to drive better, data-driven business outcomes.
Destination Info
Supports HIPAA mode
Connection Modes:
Web
Mobile
Server
Identify
When you call freshpaint.identify(), Freshpaint will create or update a User profile in Amplitude by hitting Amplitude's identify API endpoint at: https://api.amplitude.com/identify.
You can find identified Users from the User Look-Up page in Amplitude.
Amplitude Identification Parameters
The following Amplitude Identification Parameters are automatically set from Freshpaint Built-in properties:
$user_id
user_id
$device_id
device_id
$os
os_name
In addition, the following Amplitude Identification Parameters, as defined at Amplitude's identify API endpoint, are supported by Freshpaint Identify User Properties. Any Freshpaint User Properties not specified in the table below will be included as user properties in Amplitude's user_properties object.
app_version
app_version
carrier
carrier
city
city
country
country
device_brand
device_brand
device_manufacturer
device_manufacturer
device_model
device_model
device_type
device_type
dma
dma
language
language
paying
paying
os_version
os_version
platform
platform
region
region
start_version
start_version
Any remaining properties
user_properties
Note that each of these Freshpaint properties are case-sensitive.
Events
When you send an event to Amplitude from Freshpaint, Freshpaint will create an event in Amplitude by hitting Amplitude's event API endpoint at: https://api.amplitude.com/httpapi.
Events sent from Freshpaint to Amplitude will show up as standard Amplitude events. From there you can use your events in any of the Amplitude reports. You can find events associated to Users under the Event Stream section of a user profile page.
Revenue Tracking: Properties
Amplitude allows you to perform Revenue LTV analysis by including revenue parameters on Amplitude events.
Freshpaint sets Amplitude's special revenue parameters, such as revenue and quantity, using properties included on the Freshpaint event.
price
price
The price of products purchased (can be negative)
quantity
quantity
The quantity of products purchased
revenue
revenue
The revenue collected
revenueType
revenueType
The type of revenue (income, refund, etc.)
productId
productId
An identifier for the product
Note that each of these Freshpaint properties are case-sensitive.
Other Amplitude Event parameters
The following Amplitude Event Parameters are automatically set from Freshpaint Built-in properties:
$user_id
user_id
$device_id
device_id
$os
os_name
time
time
In addition, the following Amplitude Event Parameters, as defined at Amplitude's HTTP API endpoint, are supported via Freshpaint Event Properties. Any Freshpaint Event Properties not specified in the table below will be included as event properties in Amplitude's event_properties object.
adid
adid
android_id
android_id
app_version
app_version
carrier
carrier
city
city
country
country
device_brand
device_brand
device_manufacturer
device_manufacturer
device_model
device_model
device_type
device_type
dma
dma
idfa
idfa
idfv
idfv
$ip
ip
language
language
location_lat
location_lat
location_lng
location_lng
paying
paying
os_version
os_version
platform
platform
region
region
start_version
start_version
Any remaining properties
event_properties
Note that each of these Freshpaint properties are case-sensitive.
Configuration Options
Integration Settings / Options
Freshpaint allows you to configure custom integration settings with Amplitude. To do this, navigate to Destinations > Apps > Amplitude and click "Configure" for Options.
This will open a modal where you can check the options you would like to enable and click "Save". The following options are available:
Force HTTPS
Enabling this will ensure that events will always be uploaded to Amplitude's HTTPS endpoint. Otherwise, the SDK will use the current visitor's protocol.
Use Log Revenue API V2
Enabling this option will track event properties with the revenue event. For example, you would be able to track a certain event and attach
priceandquantityproperties to it. This feature will then log total revenue(price*quantity)Use Freshpaint ID for Device ID
Enable this setting to make the Amplitude javascript web SDK use the Freshpaint device ID. This improves data consistency - you'll see the same device id for data streamed from your customers' web browsers as for data backfilled from Freshpaint's servers.
Note: Changing "Use Freshpaint ID for Device ID" setting will break historical data, so only enable this if you're setting up a new Amplitude project.
Event Tracking Settings
Freshpaint allows you to configure custom event tracking settings with Amplitude. To do this Navigate to Destinations > Apps > Amplitude and click "Configure" for Event Tracking.
This will open a modal where you can check the options you would like to enable and click "Save". The following options are available:
Track Referrer
If enabled, Freshpaint will capture the user’s referrer, initial referrer, and referring domain, and send to Amplitude as user properties.
Track UTM Properties
If enabled, Freshpaint will capture UTM properties from the URL or cookie, and send to Amplitude as user properties.
Track Google Click ID
If enabled, Freshpaint will capture the Google Click ID, and send to Amplitude.
Save Referrer, URL Params, GCLID Once Per Session
If enabled then Google Click ID, Referrer, and UTM params will be tracked only once per session. New values that come in during the middle of the user's session will be ignored. Disable to always capture new values.
Batch Settings
Freshpaint allows you to configure batch settings with Amplitude. To do this, navigate to Destinations > Apps > Amplitude and click "Configure" for Batching. If enabled, Amplitude will send events in batches of Batch Threshold or every Batch Period milliseconds.
Event Transformations
Set up transformations to modify your data before it's sent to your destination. Read more about transformations here.
UTM Parameters
UTM parameters are short pieces of code that can be added to links that include information about the link, which allows you to track user interactions with specific marketing campaigns.
In order to send UTM parameters to Amplitude, navigate to Destinations > Apps > Amplitude. Then click "Configure" for the "Event Tracking" setting:
Next, check the "Track UTM properties" box and click "Save".
That's it! Now you'll see UTM parameters in Amplitude as user properties. You can read more about UTM parameters in Amplitude here.
Last updated
