Clicks

Endpoints for retrieving click event data.

Retrieve a Click

get

Retrieves the details of an existing click using its unique ID.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

The unique identifier for the click (also known as im_ref or irclickid).

Responses

200

The click object.

application/json

IdstringOptional

A generated value representing the consumer journey. Also known as im_ref or irclickid. A single Id can be associated with multiple click objects.

Example: abcdefg1hijkl2mn3opq4rStUvwxyz5a6bcdef7

CampaignIdintegerOptional

Unique identifier for the campaign associated with the click.

Example: 27154

CampaignNamestringOptional

Display name of the campaign associated with the click.

Example: Capsule Corp

ProfileIdstringOptional

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

Example: ab12345c-6789-0123-4de5-678f90g123h4

IpAddressstringOptional

Hashed IP address that the click was sourced from.

EventDatestring · date-timeOptional

Date and time when the click occurred (ISO 8601).

Example: 2021-01-25T08:06:24-05:00

MediaIdintegerOptional

Unique identifier for the partner that generated the click.

Example: 1924609

MediaNamestringOptional

Display name of the partner that generated the click.

Example: Hazel Nutt

AdIdintegerOptional

Unique identifier for the advertisement that was clicked.

Example: 3061348

AdNamestringOptional

Display name of the advertisement that was clicked.

Example: Capsule Home Spring Promo

AdTypestring · enumOptional

The type of advertisement that was clicked.

Example: BANNERPossible values:

ProductSkustringOptional

The SKU of the product the ad is marketing, if applicable.

Example: APP-0016

DealNamestringOptional

Display name of the deal associated with the click, if applicable.

Example: Capsule Home Spring Sale

DealTypestring · enumOptional

The type of deal associated with the click.

Example: GENERAL_SALEPossible values:

DealScopestring · enumOptional

The scope of the deal associated with the click.

Example: ENTIRE_STOREPossible values:

CustomerAreastringOptional

Geographical area of the customer, derived from the hashed IP address. Returns "n/a" if unavailable.

Example: San Francisco

CustomerCitystringOptional

City of the customer, derived from the hashed IP address. Returns "n/a" if unavailable.

Example: San Francisco

CustomerRegionstringOptional

Region or state of the customer, derived from the hashed IP address.

Example: California

CustomerCountrystringOptional

ISO 3166-1 alpha-2 country code of the customer, derived from the hashed IP address.

Example: US

DeviceTypestring · enumOptional

The type of device the click was generated from.

Example: DESKTOPPossible values:

DeviceFamilystring · enumOptional

The device family the click was generated from.

Example: WINDOWS_MACHINEPossible values:

Browserstring · enumOptional

The browser the click was generated from.

Example: CHROMEPossible values:

Osstring · enumOptional

The operating system the click was generated from.

Example: WINDOWS_10Possible values:

ReferringUrlstringOptional

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

Example: https://hazelwellness.blog/spring-deals

ReferringDomainstringOptional

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

Example: hazelwellness.blog

LandingPageUrlstringOptional

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

Example: https://www.capsulecorp.holdings/spring?irgwc=1

TrafficCategorystringOptional

Classification of the traffic source that generated the click.

Example: Content

TrafficSourcestringOptional

The referring site that generated the click traffic.

Example: hazelwellness.blog

BidKeywordstringOptional

The Paid Search keyword associated with the click, if applicable.

SearchTextstringOptional

The search engine query that led to the click, if the click originated from Paid Search.

SharedIdstringOptional

The Shared ID value passed on the tracking link by the partner.

Example: spring2026

CpcBidstringOptional

The partner compensation amount for the click (cost-per-click).

Payoutstring · decimalOptional

The partner payout amount for the click.

UniqueClickbooleanOptional

Whether this click meets IAB standards for a unique click.

Example: true

get/Mediapartners/{AccountSID}/Clicks/{Id}

HTTPcURLJavaScriptPython

GET /Mediapartners/{AccountSID}/Clicks/{Id} HTTP/1.1
Host: api.impact.com
Accept: */*

200

The click object.

{
  "Id": "abcdefg1hijkl2mn3opq4rStUvwxyz5a6bcdef7",
  "CampaignId": "27154",
  "CampaignName": "Capsule Corp",
  "ProfileId": "ab12345c-6789-0123-4de5-678f90g123h4",
  "IpAddress": "",
  "EventDate": "2021-01-25T08:06:24-05:00",
  "MediaId": "1924609",
  "MediaName": "Hazel Nutt",
  "AdId": "3061348",
  "AdName": "Capsule Home Spring Promo",
  "AdType": "BANNER",
  "ProductSku": "APP-0016",
  "BrandRelated": [],
  "DealName": "Capsule Home Spring Sale",
  "DealType": "GENERAL_SALE",
  "DealScope": "ENTIRE_STORE",
  "CustomerArea": "San Francisco",
  "CustomerCity": "San Francisco",
  "CustomerRegion": "California",
  "CustomerCountry": "US",
  "DeviceType": "DESKTOP",
  "DeviceFamily": "WINDOWS_MACHINE",
  "Browser": "CHROME",
  "Os": "WINDOWS_10",
  "ReferringUrl": "https://hazelwellness.blog/spring-deals",
  "ReferringDomain": "hazelwellness.blog",
  "LandingPageUrl": "https://www.capsulecorp.holdings/spring?irgwc=1",
  "TrafficCategory": "Content",
  "TrafficSource": "hazelwellness.blog",
  "BidKeyword": "",
  "SearchText": "",
  "SharedId": "spring2026",
  "PartnerRelated": [
    {
      "SubId1": "storm",
      "SubId2": "spring2026",
      "SubId3": ""
    }
  ],
  "CpcBid": "",
  "Payout": "",
  "UniqueClick": true
}