---
"@context": https://schema.org
"@type": TechArticle
"@id": https://www.twilio.com/docs/segment/connections/destinations/catalog/impact#article
headline: Impact Destination
url: https://www.twilio.com/docs/segment/connections/destinations/catalog/impact
inLanguage: en
dateModified: 2025-10-17T15:44:16.000Z
author:
  "@type": Organization
  name: Twilio Developer Education Team
publisher:
  "@type": Organization
  name: Twilio
---

# Impact Destination

## Getting Started

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](#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 Segment's [JavaScript source](/docs/segment/connections/sources/catalog/libraries/website/javascript/), Segment 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:

```js
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, Segment 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 Segment's spec'd event properties in the [Spec: Common](/docs/segment/connections/spec/common/) documentation.

**Note:** Some of the properties listed below are documented as properties of the [Order Completed](/docs/segment/connections/spec/ecommerce/v2/#order-completed) event specification. You do not need to use the 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) |

## Deep Link Opened

We integrate with Impact mobile attribution capabilities using our [Deep Link Opened](/docs/segment/connections/spec/mobile/#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            |
