Freshpaint
HomeLogin
  • Documentation
    • What is Freshpaint?
    • ⚕️HIPAA Mode
    • 🏗️Building Out Your Account
    • 🌐Overview of Features
    • Guides
      • 📡Add Autotrack to your website to collect data from your users
        • Installing the Freshpaint Javascript SDK
        • Installing the Freshpaint SDK with a Content Security Policy (CSP)
        • Installing the Freshpaint Javascript SDK with Server-Side Rendering (SSR) + React
        • Autocapture + React
        • Configuring a Destination
        • Labeling User Actions
        • How do I install Freshpaint with Typescript?
      • 🔁Send historical data to any destination with Time Machine
      • Next.js Quickstart Guide
      • Android Quickstart Guide
        • Installing the Freshpaint Android SDK
        • Configuring a Destination
        • Instrumenting Your App
      • iOS Quickstart Guide
        • Installing the Freshpaint iOS SDK
        • Configuring a Destination
        • Instrumenting Your App
      • React Native Quickstart Guide
        • Installing the Freshpaint React Native SDK
        • Configuring a Destination
        • Labeling User Actions
        • Configuring Property Capture
    • Setting up Properties
    • Setting up Your Destinations
      • Enabling and Disabling a Destination
      • Deleting a Destination
    • Setting up Your Events
    • User Identification
      • Designated Identify Properties
    • Maps
    • Analytics (Beta)
      • Web Analytics Dashboard
      • Campaigns
      • Service Lines
      • Data Glossary
    • Translations
    • Web Tracker Monitoring
      • Tracker Resolution Types
      • Historical Scans
  • Integrations
    • Destinations
      • Demand Side Platforms (DSPs)
        • Basis
          • Basis Quick Start Guide
          • Basis Reference
        • Google Campaign Manager 360
        • StackAdapt
          • StackAdapt Quick Start Guide
          • StackAdapt Reference
        • theTradeDesk
          • theTradeDesk Quick Start Guide
          • theTradeDesk Reference
          • theTradeDesk with CM360 Configuration Guide
        • Viant
          • Viant Quick Start Guide
          • Viant Reference
      • Direct Response Ads
        • Facebook Conversions API
          • Facebook Conversions API Quick Start Guide
          • Facebook Conversions API Reference
        • Google Ads Conversion API
          • Google Ads Conversion API Quick Start Guide
          • Google Ads Conversions API Reference
        • Google Ads
          • Google Ads Quick Start Guide
          • Google Ads Reference
        • LinkedIn Ads
          • LinkedIn Ads Quick Start Guide
          • LinkedIn Ads Reference
        • Microsoft Ads (formerly Bing Ads)
          • Microsoft Ads Quick Start Guide
          • Microsoft Ads Reference
          • Microsoft Ads Multi-Config Reference
        • Pinterest Ads (Beta)
          • Pinterest Ads Quick Start Guide
          • Pinterest Ads Reference
        • Pinterest Tag
        • Reddit Ads
          • Reddit Ads Quick Start Guide
          • Reddit Ads Reference
        • TikTok Ads
        • Twitter Ads
      • Data Activation
        • ActiveCampaign
          • ActiveCampaign Quick Start Guide
          • ActiveCampaign Reference
        • Amplitude
          • Amplitude Quick Start Guide
          • Amplitude Reference
        • Braze (formerly Appboy)
          • Braze Quick Start Guide
          • Braze Reference
        • Customer.io
          • Customer.io Quick Start Guide
          • Customer.io Reference
        • Freshsales
        • Google Analytics 4 Proxy
          • Google Analytics 4 Proxy Quick Start Guide
          • Google Analytics 4 Proxy Reference
          • Google Analytics 4 Proxy Advanced Tracking Configurations
        • Google Analytics 4 Server-Side
          • Google Analytics 4 Server-Side Quick Start Guide
          • Google Analytics 4 Server-Side Reference
        • Heap
        • Hotjar
        • HubSpot Cloud
        • HubSpot Web
        • impact.com
          • Impact.com Quick Start Guide
          • Impact.com Reference
        • Intercom
          • Intercom Quick Start Guide
          • Intercom Reference
        • Iterable
          • Iterable Quick Start Guide
          • Iterable Reference
        • June
        • Klaviyo
        • Mixpanel
          • Mixpanel Quick Start Guide
          • Mixpanel Reference
        • OneSignal
          • OneSignal Quick Start Guide
          • OneSignal Reference
        • Sendinblue
        • Sentry
        • Vero Cloud
        • Webengage
        • Webhooks
        • Woopra
        • Zendesk
      • Data Warehouses
        • Azure Warehouse Setup
        • BigQuery Warehouse Setup
        • Databricks Warehouse Setup
        • Postgres Warehouse Setup
        • Redshift Warehouse Setup
        • S3 Warehouse Setup
        • Snowflake Warehouse Setup
      • Consent Management
        • Osano
        • OneTrust
        • Custom Consent Manager
    • Sources
      • Web
        • Autotrack
        • Precision Tracking
      • CallRail
      • Invoca
      • Customer.io
      • Intercom
      • Mailchimp
      • React Native
      • SendGrid
      • Sendinblue
      • Server-Side
      • iOS
    • 🔷Google Tag Manager integration
      • Google Tag Manager migration
      • Quick Start Guide
    • 📺Freshpaint Video Platform
    • 🖼️Impression Pixel
  • Admin Panel
    • Event Library
      • Event Library Bulk Actions
      • Event Definition Filters
      • Event Tester
      • 🔁Time Machine
      • Visual Tagger
      • Advanced Options
        • Tag Manager
        • Disabling Target Text Capture
        • Cross Domain Tracking
    • Projects & Environments
    • Teams
      • Role-Based Access Control (RBAC)
    • Transformations
      • Standard Events
      • Modify Data
      • Modify User Data
      • SQL Transformations
    • 📈Destination Monitoring
    • 🔎Investigate: Testing and Debugging
      • Live View
      • Event Verification
  • Reference
    • Developer Docs
      • Freshpaint Web SDK Reference
      • Freshpaint Web SDK Options
      • Freshpaint React Native SDK Reference
      • Freshpaint iOS SDK Reference
      • Freshpaint Android SDK Reference
      • HTTP API
    • Frequently Asked Questions
      • How do I circumvent ad blockers?
      • Can Freshpaint track users across domains?
      • Can I install Freshpaint on a Chrome extension?
      • What properties are captured with my events?
      • How Do I Switchover From Segment?
      • How Do I Switch From Native Google Analytics to the Freshpaint Google Analytics Destination?
      • Where do I find my Environment ID?
      • Is Freshpaint GDPR & CCPA Compliant?
      • Can I use transformations to anonymize data for client-side destinations?
      • How do I QA or debug my data?
      • Why Do My Numbers Differ Across Different Tools?
      • Billing: How Does Freshpaint Determine MTUs?
      • Can I Use Freshpaint on Multiple Sites?
      • How Can I Export Data From Freshpaint?
      • How Does Freshpaint Identify Users?
      • How Many Events Should I Create?
      • What Should I Name My Events?
      • How do I track scroll depth?
      • What Data Does Freshpaint Collect?
        • Data Collected on Web
        • Data Collected on React Native
      • Does Freshpaint's Autotrack slow my site down?
      • Running Freshpaint with a Proxy
      • Should my Environment ID be treated as a sensitive key?
      • How Does Freshpaint Determine Session Count?
      • What is the difference between client-side and server-side connection mode?
      • What is a Proxy Integration?
      • Where can I view Freshpaint’s Status?
      • Does Freshpaint provide HIPAA audit logs?
      • Freshpaint Cookie Too Large
      • How does Freshpaint compare to server-side Google Tag Manager?
      • If a user re-installs my app, will Freshpaint generate a new device ID?
      • Why doesn't Freshpaint need a BAA before sending data to Google Ads and Facebook Ads?
      • What Implementation Services Does Freshpaint Offer?
      • Single Sign On (SSO) Setup
Powered by GitBook
On this page
  • Destination Info
  • Identify
  • Amplitude Identification Parameters
  • Events
  • Revenue Tracking: Properties
  • Other Amplitude Event parameters
  • Configuration Options
  • UTM Parameters

Was this helpful?

  1. Integrations
  2. Destinations
  3. Data Activation
  4. Amplitude

Amplitude Reference

PreviousAmplitude Quick Start GuideNextBraze (formerly Appboy)

Last updated 1 month ago

Was this helpful?

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

  • Accepts , , and calls

  • Supports

  • Connection Modes:

Client-side
Server-side

Web

Mobile

Server

Identify

When you call , Freshpaint will create or update a User profile in Amplitude by hitting at:

You can find identified Users from the in Amplitude.

Amplitude Identification Parameters

The following Amplitude Identification Parameters are automatically set from Freshpaint Built-in properties:

Freshpaint Built-in Property
Amplitude Identification Parameter

$user_id

user_id

$device_id

device_id

$os

os_name

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

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 v1 event endpoint, 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.

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.

Other Amplitude Event parameters

The following Amplitude Event Parameters are automatically set from Freshpaint Built-in properties:

Freshpaint Built-in Property
Amplitude Event Parameter

$user_id

user_id

$device_id

device_id

$os

os_name

time

time

Freshpaint Event 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

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 > Overview > Amplitude > Details 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 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. 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. 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 > Overview > Amplitude > Details 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 Referrer

    If enabled, Freshpaint will capture the user’s referrer, initial referrer, and referring domain, and send to Amplitude as user properties.

  2. Track UTM Properties

    If enabled, Freshpaint will capture UTM properties from the URL or cookie, and send to Amplitude as user properties.

  3. Track Google Click ID

    If enabled, Freshpaint will capture the Google Click ID, and send to Amplitude.

  4. 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

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".

In addition, the following Amplitude Identification Parameters, as defined at , are supported by . Any Freshpaint User Properties not specified in the table below will be included as user properties in Amplitude's user_properties object.

In addition, the following Amplitude Event Parameters, as defined at , 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.

Set up transformations to modify your data before it's sent to your destination. Read more about transformations .

That's it! Now you'll see UTM parameters in Amplitude as user properties. You can read more about UTM parameters in Amplitude .

Page
Track
Identify
HIPAA mode
freshpaint.identify()
Amplitude's identify API endpoint
https://api.amplitude.com/identify.
User Look-Up page
Amplitude's identify API endpoint
Freshpaint Identify User Properties
Amplitude's HTTP API endpoint
here
here