# Models

## The Click object

```json
{"openapi":"3.1.0","info":{"title":"Partner Clicks API","version":"16"},"components":{"schemas":{"Click":{"type":"object","properties":{"Id":{"type":"string","description":"A generated value representing the consumer journey. Also known as `im_ref` or `irclickid`. A single Id can be associated with multiple click objects."},"CampaignId":{"type":"integer","description":"Unique identifier for the campaign associated with the click."},"CampaignName":{"type":"string","description":"Display name of the campaign associated with the click."},"ProfileId":{"type":"string","description":"impact.com's unique identifier for a user on a specific device."},"IpAddress":{"type":"string","description":"Hashed IP address that the click was sourced from."},"EventDate":{"type":"string","format":"date-time","description":"Date and time when the click occurred (ISO 8601)."},"MediaId":{"type":"integer","description":"Unique identifier for the partner that generated the click."},"MediaName":{"type":"string","description":"Display name of the partner that generated the click."},"AdId":{"type":"integer","description":"Unique identifier for the advertisement that was clicked."},"AdName":{"type":"string","description":"Display name of the advertisement that was clicked."},"AdType":{"type":"string","enum":["BANNER","EMAIL","FLASH","TEXT","TEXT_LINK","LONG_SPONSORED_TEXT","XML_SYNDICATION","COUPON","CONTENT","VIDEO","ONLINE_TRACKING_LINK","MEDIA_SOURCE_TRACKING"],"description":"The type of advertisement that was clicked."},"ProductSku":{"type":"string","description":"The SKU of the product the ad is marketing, if applicable."},"BrandRelated":{"type":"array","description":"Brand-related data associated with the click, such as ad campaign and keyword information.","items":{"type":"object","properties":{"AdCampaign":{"type":"string","description":"Third-party ad campaign grouping name."},"AdGroup":{"type":"string","description":"Third-party ad group containing the ad."},"Keyword":{"type":"string","description":"Internal keyword associated with the ad."},"MatchType":{"type":"string","description":"Click-to-consumer matching methodology."},"Channel":{"type":"string","description":"Channel that generated the click."}}}},"DealName":{"type":"string","description":"Display name of the deal associated with the click, if applicable."},"DealType":{"type":"string","enum":["BOGO","FREE_SHIPPING","GENERAL_SALE","GIFT_WITH_PURCHASE","REBATE"],"description":"The type of deal associated with the click."},"DealScope":{"type":"string","enum":["CATEGORY","ENTIRE_STORE","PRODUCT"],"description":"The scope of the deal associated with the click."},"CustomerArea":{"type":"string","description":"Geographical area of the customer, derived from the hashed IP address. Returns \"n/a\" if unavailable."},"CustomerCity":{"type":"string","description":"City of the customer, derived from the hashed IP address. Returns \"n/a\" if unavailable."},"CustomerRegion":{"type":"string","description":"Region or state of the customer, derived from the hashed IP address."},"CustomerCountry":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the customer, derived from the hashed IP address."},"DeviceType":{"type":"string","enum":["DESKTOP","PHONE","TABLET","GAME","WATCH","TV","ROBOT","CAR","UNKNOWN"],"description":"The type of device the click was generated from."},"DeviceFamily":{"type":"string","enum":["WINDOWS_MACHINE","LINUX_MACHINE","APPLE_MAC","IPHONE","IPAD","ONE","CHROMEBOOK","UNKNOWN"],"description":"The device family the click was generated from."},"Browser":{"type":"string","enum":["CHROME","CHROME_MOBILE","UC_BROWSER","OPERA","OPERA_MOBILE","EDGE","FIREFOX","SAFARI","CAKE","AMAZON_SILK","UNKNOWN"],"description":"The browser the click was generated from."},"Os":{"type":"string","enum":["ANDROID","LINUX","IOS","WINDOWS_10","WINDOWS_7","UNKNOWN"],"description":"The operating system the click was generated from."},"ReferringUrl":{"type":"string","description":"The URL the customer came from when they generated the click."},"ReferringDomain":{"type":"string","description":"The domain the customer came from when they generated the click."},"LandingPageUrl":{"type":"string","description":"The URL the customer landed on when they generated the click."},"TrafficCategory":{"type":"string","description":"Classification of the traffic source that generated the click."},"TrafficSource":{"type":"string","description":"The referring site that generated the click traffic."},"BidKeyword":{"type":"string","description":"The Paid Search keyword associated with the click, if applicable."},"SearchText":{"type":"string","description":"The search engine query that led to the click, if the click originated from Paid Search."},"SharedId":{"type":"string","description":"The Shared ID value passed on the tracking link by the partner."},"PartnerRelated":{"type":"array","description":"Partner tracking data associated with the click, including sub-identifier values appended to the tracking link.","items":{"type":"object","properties":{"SubId1":{"type":"string","description":"First partner sub-identifier appended to the tracking link."},"SubId2":{"type":"string","description":"Second partner sub-identifier appended to the tracking link."},"SubId3":{"type":"string","description":"Third partner sub-identifier appended to the tracking link."}}}},"CpcBid":{"type":"string","description":"The partner compensation amount for the click (cost-per-click)."},"Payout":{"type":"string","format":"decimal","description":"The partner payout amount for the click."},"UniqueClick":{"type":"boolean","description":"Whether this click meets IAB standards for a unique click."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://integrations.impact.com/partner-api-reference/reference/clicks/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.