Click Object

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 ClickId (or irclickid). 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.

View possible enum values
BANNERClick was generated on a banner ad.
EMAILClick was generated on an email ad.
FLASHClick was generated on a flash player ad.
TEXTClick was generated on a sponsored text ad.
TEXT_LINKClick was generated on a text hyperlink ad.
LONG_SPONSORED_TEXTClick was generated on a long sponsored text ad.
XML_SYNDICATIONClick was generated on an XML syndication.
COUPONClick was generated on a coupon ad.
CONTENTPartner requested an additional content ad tracking value.
VIDEOClick was generated on a video ad.
ONLINE_TRACKING_LINKClick was generated on an online tracking link ad.
MEDIA_SOURCE_TRACKINGClick was generated on a media source (e.g., an SEO source).

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.

View child attributes

AdCampaign string

Name of the third-party ad grouping that the ad is grouped with.


AdGroup string

Which third-party ad group the ad is contained in (e.g., Paid Search).


Keyword string

Internal keyword associated with the ad.


MatchType string

How the click is matched to the consumer who generated it.


Channel string

Which channel generated the click.


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 4217.


DeviceType enum

What device the customer clicked or tapped the ad on.

View possible enum values
DESKTOPConsumer generated the click from a personal computer.
PHONEConsumer generated the click using a mobile phone.
TABLETConsumer generated the click using a tablet computer.
GAMEConsumer generated the click from a mobile game.
WATCHConsumer generated the click from a smart watch.
TVConsumer generated the click from a TV ad.
ROBOTA robot generated the click.
CARConsumer generated the click from a their car.
UNKNOWNThe DeviceType could not be tracked.

DeviceFamily enum

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

View possible enum values
WINDOWS_MACHINEConsumer generated the click using a Windows machine.
LINUX_MACHINEConsumer generated the click using a Linux machine.
APPLE_MACConsumer generated the click using an Apple machine.
IPHONEConsumer generated the click using an iPhone.
IPADConsumer generated the click using an iPad.
ONEConsumer generated the click using a OnePlus One mobile device.
CHROMEBOOKConsumer generated the click using a Google Chromebook.
UNKNOWNThe DeviceFamily could not be tracked.

Browser enum

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

View possible enum values
CHROMEConsumer generated the click using Google Chrome.
CHROME_MOBILEConsumer generated the click using Google Chrome on a mobile device.
UC_BROWSERConsumer generated the click using UC Browser.
OPERAConsumer generated the click using Opera.
OPERA_MOBILEConsumer generated the click using Opera on a mobile device.
EDGEConsumer generated the click using Microsoft Edge.
FIREFOXConsumer generated the click using Mozilla Firefox.
SAFARIConsumer generated the click using Apple's Safari browser.
CAKEConsumer generated the click using the mobile browser Cake.
AMAZON_SILKConsumer generated the click using Amazon's web browser, Silk.
UNKNOWNThe Browser could not be tracked.

Os enum

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

View possible enum values
ANDROIDConsumer generated the click using the Android operating system.
LINUXConsumer generated the click using the Linux operating system.
IOSConsumer generated the click using the iOS operating system.
WINDOWS_10Consumer generated the click using the Windows 10 operating system.
WINDOWS_7Consumer generated the click using the Windows 7 operating system.
UNKNOWNThe Os could not be tracked.

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

View more attributes

CpcBid string

How much the partner will be paid for driving the click.


DealName string

Name of the associated deal.


DealType enum

Type of the associated deal.

View possible enum values
BOGODeal will apply a buy-one-get-one deal to the order.
FREE_SHIPPINGDeal applies free shipping to the order.
GENERAL_SALEDeal applies a general discount to the products identified in `DealScope`.
GIFT_WITH_PURCHASEA gift will come with the order.
REBATEA rebate will be available to the customer upon purchase.

DealScope enum

To what extent the deal applies to the click.

View possible enum values
CATEGORYDeal applies to a category of products.
ENTIRE_STOREDeal applies to the entire store.
PRODUCTDeal only applies to a specific product or a specific group of products.

PartnerRelated array

A partner's information that is related to the click event.

View child attributes

SubId1 string

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


SubId2 string

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


SubId3 string

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


Payout decimal

Partner's payout for driving the click.


TrafficCategory string

What kind of traffic is generating the click.


TrafficSource string

Referring site (aka Source) of the traffic generating the click.


BidKeyword string

If the click was generated from a Paid Search, then this will be the keyword used in that Paid search.


SearchText string

If the click was generated from a Paid Search, then this will be the search query the customer put into a search engine.

{
  "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"
}