The click object holds information about a click action. You can retrieve a click, as well as list all clicks.

Attributes

Id string

A generated value that represents the consumer journey — also known as im_ref. This value can be associated with multiple click objects.

CampaignId integer

Program (formerly known as campaign) Id associated with the click.

CampaignName string

Program (formerly known as campaign) name associated with the click.

ProfileId string

impact.com's unique identifier for a user on a specific device.

IpAddress string

Hashed IP address that the click was sourced from. This attribute is used to determine Customer attributes (e.g., CustomerCity).

EventDate string

Date and time this click happened. See ISO 8601.

MediaId integer

Partner Id that drove the click.

MediaName string

Partner name that drove the click.

AdId integer

Id of the ad that was clicked.

AdName string

Name of the ad that was clicked.

AdType enum

Type of the ad that was clicked.

ProductSku string

Unique stock-keeping unit (SKU) Id that represents the item that the ad is marketing. This Id will coincide with the item's SKU Id as it is listed in the product catalog.

BrandRelated array

Your brand's information that is related to the click event.

CustomerArea string

Generated from the IpAddress attribute, this is the geographical area from where the customer generated the click. If IpAddress was not tracked, n/a will appear.

CustomerCity string

Generated from the IpAddress attribute, this is the city from where the customer generated the click. If IpAddress was not tracked, n/a will appear.

CustomerRegion string

Generated from the IpAddress attribute, this is the geographical region from where the customer generated the click. If IpAddress was not tracked, n/a will appear.

CustomerCountry string

Generated from the IpAddress attribute, this is the country from where the customer generated the click. If IpAddress was not tracked, n/a will appear.
See ISO 3166-1 alpha-2.

DeviceType enum

What device the customer clicked or tapped the ad on.

DeviceFamily enum

General group of devices that the attribute DeviceType comes from. Only a sample of all enum values are presented below.

Browser enum

Which web browser the customer used when they generated the click. Only a sample of all enum values are presented below.

Os enum

Which operating system the customer used when they generated the click. Only a sample of all enum values are presented below.

ReferringUrl string

The URL that the customer came from when they generated the click.

ReferringDomain string

The web domain that the customer came from when they generated the click.

LandingPageUrl string

The URL the customer landed on when they generated the click.

SharedId string

A SharedId that is passed on the tracking link the partner used.

UniqueClick boolean

If the click follows IAB standards for a "unique click."

More attributes

{
  "Id": "abcdefg1hijkl2mn3opq4rStUvwxyz5a6bcdef7",
  "CampaignId": "1000",
  "CampaignName": "Acme Campaign",
  "ProfileId": "ab12345c-6789-0123-4de5-678f90g123h4",
  "IpAddress": "abcdefghijklmnopqrstuvwxyz1234567890",
  "EventDate": "2021-01-25T08:06:24-05:00",
  "MediaId": "10000",
  "MediaName": "Partner Person",
  "AdId": "656565",
  "AdName": "Our Anvils Are Awesome",
  "AdType": "BANNER",
  "BrandRelated": {
    "AdCampaign": " ",
    "AdGroup": " ",
    "Channel": "Affiliate/CPA Network",
    },
  "CustomerArea": "n/a",
  "CustomerCity": "n/a",
  "CustomerRegion": "n/a",
  "CustomerCountry": "US",
  "DeviceType": "UNKNOWN",
  "DeviceFamily": "null",
  "Browser": "null",
  "Os": "null",
  "ReferringDomain": "NA",
  "LandingPageUrl": "http://google.com?irgwc=1",
  "CpcBid": "0.0",
  "UniqueClick": "true"
}