Amplitude
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.
- Connection Modes:
Client-side | Server-side | |
|---|---|---|
Web | ||
Mobile | ||
Server |
To set up the Amplitude integration, follow these steps:
- 1.
- 2.In Amplitude, go to your settings page and copy/paste your Project API Key into the Credentials setting in Freshpaint. Note: only Admins and Managers can view the API Key in Amplitude. See Amplitude's docs for step-by-step instructions on how to find your Project API Key.
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.
The following Amplitude Identification Parameters are automatically set from Freshpaint Built-in properties:
user_id, device_id, and os_name.In addition, the following Amplitude Identification Parameters, as defined at Amplitude's identify API endpoint, are set from any same-named Freshpaint Identify User Properties supplied (Freshpaint includes any remaining non-Amplitude-identification-parameter properties in Amplitude's
user_properties.)Freshpaint User Property | Amplitude Identification Parameter |
|---|---|
app_version | app_version |
carrier | carrier |
city | city |
country | country |
device_brand | device_brand |
device_manufacturer | device_manufacturer |
device_model | device_model |
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.
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.
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. Freshpaint Property | Amplitude Event parameter | Description |
|---|---|---|
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.
The following Amplitude Event Parameters are automatically set from Freshpaint Built-in properties:
user_id, device_id, os_name, and time.In addition, the following Amplitude Event Parameters, as defined at Amplitude's HTTP API endpoint, are set from any same-named Freshpaint Properties supplied (Freshpaint includes any remaining non-Amplitude-event-parameter properties in Amplitude's
event_properties.)Freshpaint User Property | Amplitude Event parameter |
|---|---|
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 |
dma | dma |
idfa | idfa |
idfv | idfv |
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.
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:
- 1.Force HTTPSEnabling this will ensure that events will always be uploaded to Amplitude's HTTPS endpoint. Otherwise, the SDK will use the current visitor's protocol.
- 2.Use Log Revenue API V2Enabling 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) - 3.Use Freshpaint ID for Device IDEnable 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.
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:
- 1.Track ReferrerIf enabled, Freshpaint will capture the user’s referrer, initial referrer, and referring domain, and send to Amplitude as user properties.
- 2.Track UTM PropertiesIf enabled, Freshpaint will capture UTM properties from the URL or cookie, and send to Amplitude as user properties.
- 3.Track Google Click IDIf enabled, Freshpaint will capture the Google Click ID, and send to Amplitude.
- 4.Save Referrer, URL Params, GCLID Once Per SessionIf 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.
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.
Set up transformations to modify your data before it's sent to your destination. Read more about transformations here.
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 modified 15d ago