# Get clicks

**GET /accounts/{account_id}/clicks**

Fetch all clicks processed by ClickGUARD in the given period

Available on: 
![AuditGUARD](https://storage.googleapis.com/clickguard-storage-dev/public/assets/api-docs/audit-off.png) ![AlertGUARD](https://storage.googleapis.com/clickguard-storage-dev/public/assets/api-docs/active-off.png) ![PremiumGUARD](https://storage.googleapis.com/clickguard-storage-dev/public/assets/api-docs/premium-on.png) ![EliteGUARD](https://storage.googleapis.com/clickguard-storage-dev/public/assets/api-docs/elite-on.png)



## Servers



## Parameters

### Path parameters
- **account_id** (string)
  ID of an account

### Query parameters
- **period** (string)
  Period to fetch the clicks for.
- **sort** (string)
  Sort the clicks by a specified parameter. Use '-' prefix to indicate a descending sort. Default: '-timestamp'.
- **offset** (number)
  Paginating parameter. Offset the result by a specified number. Default: 0.
- **limit** (number)
  Paginating parameter. Limit the number of result by a specified number. Max: 100. Default: 50.
- **status** (string)
  Status of the click
- **ppc** (boolean)
  Filter ad clicks or organic clicks only
- **gclid** (string)
  Google assigned click ID
- **converted** (boolean)
  Filter by conversion
- **ip** (string)
  IP address of a click
- **ip-range** (string)
  IP address range (CIDR notation) of a click
- **device_id** (string)
  Device ID of a click
- **campaign** (string)
  Campaign ID of an ad click
- **keyword** (string)
  Keyword ID from an ad click
- **placement** (string)
  Domain placement of an ad click
- **country** (string)
  Originating country of a click


## Responses
### 200
Successful operation

#### Body:  (array[object])
- **id** (string)
  Unique identifier of a click
- **timestamp** (string(date-time))
  The timestamp of the moment click happened
- **ip** (string)
  IP address where the click came from
- **ip_type** (number)
  IP address version, can be 4 or 6
- **hostname** (string | null)
  Domain hostname corresponding to the IP address.
- **ppc** (boolean)
  Flag indicating if this was a paid click
- **gclid** (string | null)
  Google Ads click ID.
- **status** (string)
  The status of the click.
- **referrer** (string | null)
  The click referrer domain.
- **flags** (array[string])
  An array of applied flags
- **notes** (array[string])
  An array of items describing why the rule was triggered
- **actions** (array[object])
  An array of items with information on taken actions
- **device_type** (string)
  The identified device type.
- **device_id** (string | null)
  The unique device ID generated by post-click tracking.
- **browser** (string | null)
  The name of the used web browser.
- **browser_version** (string | null)
  The version of the used web browser.
- **os** (string | null)
  The name of the used operating system.
- **os_version** (string | null)
  The version of the used operating system.
- **domain** (string)
  The domain of the landing page. Will be Google domain in case of parallel tracking.
- **url** (string)
  The full URL of the landing page. Will be Google URL in case of parallel tracking.
- **campaign_id** (string | null)
  Google Ads campaign ID for the ad click.
- **campaign_name** (string | null)
  Google Ads campaign name for the ad click.
- **adgroup_id** (string | null)
  Google Ads ad group ID for the ad click.
- **adgroup_name** (string | null)
  Google Ads ad group name for the ad click.
- **ad_id** (string | null)
  Google Ads ad ID for the ad click.
- **keyword_id** (string | null)
  Google Ads keyword ID for the ad click.
- **keywords** (string | null)
  Google Ads keywords text for the ad click.
- **ad_url** (string | null)
  The landing page URL defined in the ad.
- **parallel_tracking** (boolean)
  The flag indicating the ad click was tracked with parallel tracking.
- **network** (string | null)
  The corresponding ad network.
- **match_type** (string | null)
  The keyword match type.
- **placement** (string | null)
  The placement domain for the ad clicks on the display network.
- **continent_code** (string | null)
  ISO code for the continent in clicks geolocation.
- **continent** (string | null)
  Common name for the continent in clicks geolocation.
- **country_code** (string | null)
  ISO code for the country in clicks geolocation.
- **country** (string | null)
  Common name for the country in clicks geolocation.
- **city** (string | null)
  The city name in clicks geolocation.
- **region** (string | null)
  The region name in clicks geolocation.
- **zip_code** (string | null)
  The zip code in clicks geolocation.
- **timezone** (string | null)
  The ISO timezone in clicks geolocation.
- **aso** (string | null)
  The address supporting organization.
- **isp** (string | null)
  The internet service provider.
- **crawler** (string | null)
  The crawler name if the click came from a crawler bot.
- **proxy** (string | null)
  The proxy type if the click originated from a detected proxy.
- **threat_level** (string | null)
  The determined general threat level for this click.
- **whitelisted** (boolean)
  If the click was whitelisted according to ClickGUARD settings.
- **converted** (boolean)
  If the click has converted using conversion tracking code.
- **converted_comment** (string | null)
  Comment added to the conversion.
- **converted_value** (number | null)
  Value added to the conversion.
- **time_spent** (number | null)
  Time the visitor spent on the website in miliseconds.
- **page_views** (number | null)
  Number of pages the visitor viewed on the website.
- **user_interaction** (string | null)
  Website interaction level determined by the post-click analysis.
- **bot_probaility** (string | null)
  Bot probability level determined by the post-click analysis.


[Powered by Bump.sh](https://bump.sh)