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
  • Events
  • Track Events
  • Identify Events

Was this helpful?

  1. Integrations
  2. Destinations
  3. Data Activation
  4. impact.com

Impact.com Reference

Send advertising events directly to impact.com

PreviousImpact.com Quick Start GuideNextIntercom

Last updated 1 month ago

Was this helpful?

Destination Info

  • Supports and calls

  • Supports

  • Supports forwarding from the

  • Refer to this destination as impactdotcom in the

  • Connection Modes:

Client-side
Server-side

Web

Mobile

Server

This is a reference document for the impact.com destination. For information on how to set up this integration, see the Impact.com Quick Start Guide.

Events

When you send an event to impact.com from Freshpaint, Freshpaint will create an event in impact.com by hitting impact.com's API.

Track Events

When you send an event to impact.com, you can track conversions from your ads based on those events.

Below are the Required, Recommended, and Optional properties which are mapped to the request:

Freshpaint

Track Built-in or Event property

impact.com API field

Type

Required? Recommended?

Description

$irclickid

ClickId

string

Required Built-in

impact.com passes a unique irclickid query string parameter into the landing page URL when redirecting the user through our tracking domains. The value associated with this parameter is used to perform attribution analysis.

order_id

OrderId

string

Required

time

EventDate

string

Always-sent Built-in

$device_id

CustomProfileId

string

Always-sent Built-in

$ip

IpAddress

string

Optional Built-in

$os

DeviceOs

string

Optional Built-in

$user_agent

UserAgent

string

Optional Built-in

$user_id

CustomerId

string

Optional Built-in

The unique ID for the customer that converted.

Needs to be 7 or more characters, with 3 being distinct, and without whitespace.

amount

Amount

number

Optional

currency

CurrencyCode

string

Optional

The ISO 4217 currency code for the revenue value.

customer_status

CustomerStatus

string

Optional

discount

OrderDiscount

number

Optional

email

CustomerEmail

string

Optional

This is SHA1 hashed as recommended by impact.com. If in HIPAA mode, and Masking specified for the Allowlisted email Event Property, this is performed prior to the SHA1 hashing.

event_type_code

EventTypeCode

string

Required (if event_type_id not specified)

If specified, identifies impact Event Type, and used as Freshpaint event name

event_type_id

EventTypeId

number

Required (if event_type_code not specified)

If specified, identifies impact Event Type, and used as Freshpaint event name

items

ItemBrand# ItemCategory# ItemPromoCode# ItemName# ItemPrice# ItemQuantity# ItemSku#

object array

Optional

example: items: [ { subTotal: 28.00, category: "Product Category 1", sku: "sku-11111", quantity: 2, name: "Product Name 1", }, { subTotal: 99.00, category: "Product Category 2", sku: "sku-11112", quantity: 3, name: "Product Name 2", }]

item_brand#

ItemBrand#

string

Optional

item-level detail such as item_brand1, item_brand2...item_brandN

item_category#

ItemCategory#

string

Optional

""

item_promo_code#

ItemPromoCode#

number

Optional

""

item_name#

ItemName#

string

Optional

""

item_price#

ItemPrice#

number

Optional

""

item_quantity#

ItemQuantity#

number

Optional

""

item_sku#

ItemSku#

string

Optional

""

latitude

Latitude

number

Optional

longitude

Longitude

number

Optional

order_promo_code

OrderPromoCode

string

Optional

order_shipping

OrderShipping

number

Optional

order_tax

OrderTax

number

Optional

os_version

DeviceOsVersion

string

Optional

Freshpaint will deliver Track events to impact.com only when a user arrives on your site by clicking on an ad that directs the user to a landing page that has Freshpaint installed. Without the irclickid ($irclickid) from the landing page, Freshpaint and impact.com will not be able to attribute conversions.

Identify Events

Freshpaint Identify Built-in or User property

impact.com API field

Type

Required? Recommended?

Description

$current_url

PageUrl

string

Always-sent Built-in

PageUrl is a required impact api field.

It will always be sent by Freshpaint - when not allowlisted, the path and querystring params, if any, are replaced by "url-redacted-by-freshpaint"

time

EventDate

string

Always-sent Built-in

$device_id

CustomerProfileId

string

Always-sent Built-in

$irclickid

ClickId

string

Optional

Freshpaint treats ClickId as optional for Page Load, since CustomerProfileId is always sent, satisfying the impact.com required fields criteria.

$ip

IpAddress

string

Optional Built-in

$os

DeviceOs

string

Optional

$referrer

ReferringUrl

string

Optional

$user_agent

UserAgent

string

Optional Built-in

$user_id

CustomerId

string

Optional Built-in

The unique ID for the customer that converted.

Needs to be 7 or more characters, with 3 being distinct, and without whitespace.

email

CustomerEmail

string

Optional

This is SHA1 hashed as recommended by impact.com. If in HIPAA mode, and Masking specified for the Allowlisted email User Property, this is performed prior to the SHA1 hashing.

os_version

DeviceOsVersion

string

Optional

Set via (USERID). From event tester, use distinct_id. When in HIPAA mode, this is anonymized as described at

When you call , Freshpaint will set $user_id and send a to impact.com, with CustomerId set to this $user_id value. If in HIPAA mode, this value is masked as described .

Below are the properties which are mapped to the request.

Set via (USERID). From event tester, use distinct_id. When in HIPAA mode, this is anonymized as described at

Track
Identify
HIPAA mode
Google Tag Manager Integration
Integrations object
impact.com Conversion
freshpaint.identify()
"Page Load" request
here
impact.com Page Load
freshpaint.identify
ID Masking
freshpaint.identify
ID Masking