Freshpaint
Search…
⌃K
Links

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.

Destination Info

Client-side
Server-side
Web
Web
Mobile
Mobile
Server
Server

Getting Started

To set up the Amplitude integration, follow the following steps:
  1. 1.
    Go to the Amplitude configuration page in Freshpaint and click "Configure".
  2. 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.

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.

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 properties on Amplitude events.
Freshpaint sets Amplitude's special revenue properties, such as $revenue and $quantity, using properties included on the event. Freshpaint includes any remaining non-revenue properties in Amplitude's $eventProperties.
Freshpaint Property
Amplitude Property
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
Any remaining properties
$eventProperties
Other event properties to include on the revenue event
Note that each of these Freshpaint properties are case-sensitive, and should not be prefixed with a $.

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:
  1. 1.
    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.
  2. 2.
    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 price and quantity properties to it. This feature will then log total revenue (price*quantity)
  3. 3.
    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:
  1. 1.
    Track Referrer
    If enabled, Amplitude will capture the user’s referrer, initial referrer, and referring domain as user properties
  2. 2.
    Track UTM Properties
    If enabled, Amplitude will capture UTM properties from the URL or cookie as user properties.
  3. 3.
    Track Google Click ID
    If enabled, Amplitude will capture the google click ID.
  4. 4.
    Save Referrer, URL Params, GCLID Once Per Session
    If enabled then Google Click ID, Referrer, and UTM params will only be tracked 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 seconds.

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.