---
title: "Retrieve a click"
method: GET
path: "/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Clicks/{ClickId}"
tags: ["Clicks"]
---

# Retrieve a click

`GET /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Clicks/{ClickId}`

## Request

- Base URL: `https://api.impact.com`
- URL: `https://api.impact.com/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Clicks/{ClickId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/impact/apis/brand-api-account-information/docs/Advertisers/:AccountSID/Campaigns/:CampaignId/Clicks/:ClickId/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `AccountSID` string, required
- `CampaignId` integer, required
- `ClickId` string, required

## Response `200`

Returns a click object.

- Click
  - `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-time: 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` '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.
  - `ProductSku` string: SKU of the item the ad is marketing.
  - `BrandRelated` object: Your brand's information that is related to the click event.
    - `AdCampaign` string
    - `AdGroup` string
    - `Keyword` string
    - `MatchType` string
    - `Channel` string
  - `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` 'DESKTOP' | 'PHONE' | 'TABLET' | 'GAME' | 'WATCH' | 'TV' | 'ROBOT' | 'CAR' | 'UNKNOWN': What device the customer clicked or tapped the ad on.
  - `DeviceFamily` string: General group of devices that the attribute DeviceType comes from. Only a sample of all enum values are presented below.
  - `Browser` string: Which web browser the customer used when they generated the click. Only a sample of all enum values are presented below.
  - `Os` string: Which operating system the customer used when they generated the click. Only a sample of all enum values are presented below.
  - `ReferringUrl` string, uri: 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, uri: 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."
  - `CpcBid` string: How much the partner will be paid for driving the click.
  - `DealName` string: 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.
  - `PartnerRelated` object: A partner's information that is related to the click event.
    - `SubId1` string
    - `SubId2` string
    - `SubId3` string
  - `Payout` number: 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.

---

[API](https://skmtc.dev/impact/apis/brand-api-account-information.md) - [All operations](https://skmtc.dev/impact/apis/brand-api-account-information/llms.txt) - [OpenAPI document](https://skmtc.dev/impact/apis/brand-api-account-information/revisions/c53422ebb833?raw)