API Reference

Retrieve a click

Retrieves the details of a click. Supply the generated click Id value (also known as the ClickId or irclickid value).

👍

Tip

When retrieving a click, any given Id value can be associated with multiple clicks — this value simply represents the consumer journey, which can sometimes have multiple clicks. While this value is often unique, it isn't always.

❗️

Rate Limits

Remember that rate limits will apply if you attempt to retrieve too many specific clicks within a short amount of time.

Parameters

No parameters.

Returns

Returns a click object if a valid identifier is provided. Returns an error for invalid click identifiers.

Example request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Campaigns/1000/Clicks/abcdefg1hijkl2mn3opq4rStUvwxyz5a6bcdef7' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

Example response

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