Sign in
latestOpenAPI 3.1.02026-08-1039111206.0 KB

c53422ebb833

Clicks

Retrieve a click

Retrieves the details of a click using the generated ClickId (irclickid). Note: A single Id can be associated with multiple clicks in a consumer journey. Rate limits apply to this endpoint.

get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Clicks/{ClickId}

Path parameters

AccountSIDstring required

The unique identifier for the account.

CampaignIdinteger required

The ID of the program (campaign) associated with the click.

ClickIdstring required

The generated ClickId (or irclickid) representing the consumer journey.

Response

Returns a click object.

Idstring

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

CampaignIdinteger

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

CampaignNamestring

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

ProfileIdstring

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

IpAddressstring

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

EventDatestring date-time

Date and time this click happened. See ISO 8601 .

MediaIdinteger

Partner Id that drove the click.

MediaNamestring

Partner name that drove the click.

AdIdinteger

Id of the ad that was clicked.

AdNamestring

Name of the ad that was clicked.

AdType'BANNER' | 'EMAIL' | 'FLASH' | 'TEXT' | 'TEXT_LINK' | 'LONG_SPONSORED_TEXT' | 'XML_SYNDICATION' | 'COUPON' | 'CONTENT' | 'VIDEO' | 'ONLINE_TRACKING_LINK' | 'MEDIA_SOURCE_TRACKING'

Type of the ad that was clicked.

ProductSkustring

SKU of the item the ad is marketing.

CustomerAreastring

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.

CustomerCitystring

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.

CustomerRegionstring

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.

CustomerCountrystring

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'DESKTOP' | 'PHONE' | 'TABLET' | 'GAME' | 'WATCH' | 'TV' | 'ROBOT' | 'CAR' | 'UNKNOWN'

What device the customer clicked or tapped the ad on.

DeviceFamilystring

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

Browserstring

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

Osstring

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

ReferringUrlstring uri

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

ReferringDomainstring

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

LandingPageUrlstring uri

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

SharedIdstring

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

UniqueClickboolean

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

CpcBidstring

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

DealNamestring

Name of the associated deal.

DealType'BOGO' | 'FREE_SHIPPING' | 'GENERAL_SALE' | 'GIFT_WITH_PURCHASE' | 'REBATE'

Type of the associated deal.

DealScope'CATEGORY' | 'ENTIRE_STORE' | 'PRODUCT'

To what extent the deal applies to the click.

Payoutnumber

Partner's payout for driving the click.

TrafficCategorystring

What kind of traffic is generating the click.

TrafficSourcestring

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

BidKeywordstring

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

SearchTextstring

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