Impact.com Reference

Send advertising events directly to impact.com

Destination Info

• Supports Track and Identify calls

• Supports HIPAA mode

• Refer to this destination as impactdotcom in the Integrations object

• 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 impact.com Conversion 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. Set via freshpaint.identify(USERID). From event tester, use distinct_id. When in HIPAA mode, this is anonymized as described at ID Masking
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_revenue	OrderRevenue	number	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

When you call freshpaint.identify(), Freshpaint will set $user_id and send a "Page Load" request to impact.com, with CustomerId set to this $user_id value. If in HIPAA mode, this value is masked as described here.

Below are the properties which are mapped to the impact.com Page Load request.

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. Set via freshpaint.identify(USERID). From event tester, use distinct_id. When in HIPAA mode, this is anonymized as described at ID Masking
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