Impact Destination


Getting Started

Before you start, make sure Impact supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.

Web Mobile Server
📱 Device-mode
☁️ Cloud-mode

To get started, you will need to ensure your account has access to the Impact API and obtain the following keys/tokens from your Impact account:

For tracking on Web, you will need your…

  1. Account SID Your Account SID can be found by clicking on the gear icon in the top right of your Impact Dashboard and selecting Technical Settings.

  2. Authentication Token Can be found in the same place as your Account SID (labeled Auth Token)

  3. Tracking Domain From your Impact Dashboard, click on Tracking Settings > General. The tracking domain should look something like projectname.sjv.io.

    For all tracking sources (web, mobile, server) you will need your…

  4. Campaign ID Your campaign id will be displayed in the top right corner of your Impact dashboard. It will be the four numbers next to your campaign name.


Track

Web / Server

To track events from web / server locations, you will need to choose the Action Trackers you would like to map your Segment events to. Action Tracker / Segment Event mappings are established in your destination settings.

Click Id

Impact passes a query parameter named CLICKID as a part of their tracking urls. The value associated with this parameter is used to perform attribution analysis on their end. By default, if you are using our Javascript source, we will automatically look for this parameter and if it exists, pass it as a contextual property of any events that happen on the same pageview. However, we do not cache this id anywhere so any subsequent events the user takes outside of that initial pageview will not have the ClickId as part of the event.

Impact recommends you cache this value in the users browser (using a cookie or local storage) if you want to attribute any subsequent user interactions to the initial ad source. We ask that you continue doing this if you are using this integration to track web conversions and pass the cached id as part of the context.referrer object. It should look like this:

analytics.track('Some Conversion Event' { someProperty: true }, {
  context: {
    referrer: {
      type: 'impactRadius',
      id: <CACHED_CLICK_ID>
    }
  }
})

Mobile

To track events from mobile, you will need to map your mobile event codes in Impact with your Segment events. You can find your Mobile Apps and their associated events/event codes by clicking on Tracking Settings > Mobile Apps in your Impact Dashboard. These event codes need to be mapped to Segment event names as an integration setting.

Property Mappings

Once you have established Action Tracker / Mobile Event code mappings, we will perform the following data translations laid out in the tables below. Review these carefully as you may need to add some properties to your Segment events to conform to Impact’s API requirements. You can learn more about our spec’d event properties here.

Note: Some of the properties listed below are documented as properties of our Order Completed event specification. You do not need to use our Order Completed event to use this integration but you may need to add some of the properties that are traditionally included in that event “type” to the events that you would like to integrate with Impact.

Mobile Sources

These mappings will occur for data originating from mobile devices.

Segment Property Impact Parameter Required
context.app.namespace AppPackage True
context.device.adTrackingEnabled AppleAdTrack False
context.app.name AppName False
context.app.version AppVer False
context.device.manufacturer DeviceMfr False
context.device.model DeviceModel False
context.network.carrier DeviceCarrier False
context.os.name DeviceOs False
context.os.version DeviceOsVer False
context.locale DeviceLocale False
context.ip IpAddressCarrier False
context.network.wifi IpAddressWifi False
context.location.latitude Latitude False
context.location.longitude Longitude False

All Sources

These mappings will occur for events originating from any data source (Web, Mobile, Server)

Segment Property Impact Parameter Required
context.traits.status CustomerStatus False
context.traits.address.city CustomerCity False
context.traits.address.country CustomerCountry False
context.traits.email CustomerEmail False
context.traits.postalCode CustomerPostCode False
userId CustomerId False
properties.orderId OrderId False
properties.coupon OrderPromoCode False
properties.discount OrderDiscount False
properties.revenue OrderSubTotalPreDiscount False
properties.total OrderSubTotalPostDiscount False
properties.shipping OrderShipping False
properties.tax OrderTax False
properties.currency CurrencyCode False
context.userAgent UserAgent False
context.ip IpAddress False
properties.products[i].brand ItemBrand${i} False
properties.products[i].price ItemPrice${i} False
properties.products[i].name ItemName${i} False
properties.products[i].sku ItemSku${i} True (For Sale Conversions)
properties.products[i].category ItemCategory${i} True (For Sale Conversions)
products[i].quantity * products[i].price ItemSubTotal${i} True (For Sale Conversions)

We integrate with Impact mobile attribution capabilities using our Deep Link Opened event. When a Deep Link Opened event is fired we will first check to see if the referrer url (sent as the url property of the properties object) matches your Impact tracking domain. If so, we will look for the following contextual properties and pass them as metadata to Impact.

Segment Property Impact Parameter
context.ip device_ip
context.locale locale
context.app.name app_name
context.app.namespace package_name
context.app.version app_version
context.device.model device_model
context.device.manufacturer device_brand
context.os.version os_version
context.network.carrier device_carrier
context.location.latitude geo_latitude
context.location.longitude geo_longitude
context.campaign install_referrer
context.device.advertisingId appleifa
context.device.advertisingId googleaid

Personas

You can send computed traits and audiences generated using Segment Personas to this destination as a user property. To learn more about Personas, contact us for a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicade membership. For example, when a user first completes an order in the last 30 days, Personas sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Personas sets that value to false.

When you first create an audience, Personas sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Supported Sources and Connection Modes

Before you start, make sure Impact supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.

Web Mobile Server
📱 Device-mode
☁️ Cloud-mode

Segment offers an optional Device-based Connection Mode for Mobile data going to Impact, so that you can use Impact features that collect data directly from the mobile device. To do this, you must package the Segment-Impact mobile SDK with the Segment mobile library.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

Account SID

Your Impact Account SID. This can be found by clicking on the gear icon in your Impact dashboard and selecting API Access. Please contact your Impact support team if your are having issues finding this.

Action Trackers

This setting is used to map your Segment event names to Impact Action Trackers. Please enter the name(s) of the Segment track events you would like to use on the left and the Action Tracker Id’s they should integrate with on the right. Please reference our documentation for more info.

Authorization Token

Your Impact Authorization Token. This can be found by clicking on the gear icon in your Impact dashboard and selecting API Access (it will be labeled Auth Token). Please contact your Impact support team if your are having issues finding this.

Campaign ID

Each Segment data source needs to be associated with an Impact Campaign ID. This ID can be found in the top right corner of your Impact dashboard. It is the number next to the name of your Impact project.

Mobile Events

This setting is used to map your Segment events to your Mobile App Events in Impact. Each mapping consists of the Segment event name and the corresponding App ID and Event Code you would like to map it to. Please reference our documentation for more info.

Tracking Domain

Your Impact tracking domain is used to properly attribute conversion events. To find yours, from your Impact dashboard click on Tracking Settings > General. It should look like projectname.sjv.io.

Adding Impact to the integrations object

To add Impact to the integrations JSON object (for example, to filter data from a specific source), use one of the following valid names for this integration:

  • Impact Radius

  • Impact

This page was last modified: 14 Jul 2020

Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account