# Models ## The Click object ```json {"openapi":"3.1.0","info":{"title":"Brand API - Clicks","version":"v12"},"components":{"schemas":{"Click":{"type":"object","properties":{"Id":{"type":"string","description":"Generated value representing the consumer journey (ClickId/irclickid)."},"CampaignId":{"type":"integer","description":"Program (campaign) Id associated with the click."},"CampaignName":{"type":"string","description":"Program (campaign) name 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 this click happened."},"MediaId":{"type":"integer","description":"Partner Id that drove the click."},"MediaName":{"type":"string","description":"Partner name that drove the click."},"AdId":{"type":"integer","description":"Id of the ad that was clicked."},"AdName":{"type":"string","description":"Name of the ad 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":"Type of the ad that was clicked."},"ProductSku":{"type":"string","description":"SKU of the item the ad is marketing."},"BrandRelated":{"type":"object","properties":{"AdCampaign":{"type":"string"},"AdGroup":{"type":"string"},"Keyword":{"type":"string"},"MatchType":{"type":"string"},"Channel":{"type":"string"}},"description":"Your brand's information that is related to the click event."},"CustomerArea":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","enum":["DESKTOP","PHONE","TABLET","GAME","WATCH","TV","ROBOT","CAR","UNKNOWN"],"description":"What device the customer clicked or tapped the ad on."},"DeviceFamily":{"type":"string","description":"General group of devices that the attribute DeviceType comes from. Only a sample of all enum values are presented below."},"Browser":{"type":"string","description":"Which web browser the customer used when they generated the click. Only a sample of all enum values are presented below."},"Os":{"type":"string","description":"Which operating system the customer used when they generated the click. Only a sample of all enum values are presented below."},"ReferringUrl":{"type":"string","format":"uri","description":"The URL that the customer came from when they generated the click."},"ReferringDomain":{"type":"string","description":"The web domain that the customer came from when they generated the click."},"LandingPageUrl":{"type":"string","format":"uri","description":"The URL the customer landed on when they generated the click."},"SharedId":{"type":"string","description":"A SharedId that is passed on the tracking link the partner used."},"UniqueClick":{"type":"boolean","description":"If the click follows IAB standards for a \"unique click.\""},"CpcBid":{"type":"string","description":"How much the partner will be paid for driving the click."},"DealName":{"type":"string","description":"Name of the associated deal."},"DealType":{"type":"string","enum":["BOGO","FREE_SHIPPING","GENERAL_SALE","GIFT_WITH_PURCHASE","REBATE"],"description":"Type of the associated deal."},"DealScope":{"type":"string","enum":["CATEGORY","ENTIRE_STORE","PRODUCT"],"description":"To what extent the deal applies to the click."},"PartnerRelated":{"type":"object","properties":{"SubId1":{"type":"string"},"SubId2":{"type":"string"},"SubId3":{"type":"string"}},"description":"A partner's information that is related to the click event."},"Payout":{"type":"number","format":"decimal","description":"Partner's payout for driving the click."},"TrafficCategory":{"type":"string","description":"What kind of traffic is generating the click."},"TrafficSource":{"type":"string","description":"Referring site (aka Source ) of the traffic generating the click."},"BidKeyword":{"type":"string","description":"If the click was generated from a Paid Search, then this will be the keyword used in that Paid search."},"SearchText":{"type":"string","description":"If the click was generated from a Paid Search, then this will be the search query the customer put into a search engine."}}}}}} ``` --- # 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/brand-api-reference/brand-api-reference-v12/reference/clicks/models.md?ask= ``` 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.