Geo-location stats

GET /accounts/{account_id}/geo

Data regarding geo-location of the ad clicks

Available on: AuditGUARD AlertGUARD PremiumGUARD EliteGUARD

Path parameters

account_id string Required

ID of an account

Query parameters

period string Required

Period to fetch stats for

Values are TODAY, YESTERDAY, THIS_WEEK, LAST_WEEK, THIS_MONTH, LAST_MONTH, LAST_30_DAYS, or LAST_3_MONTHS.

Responses

200

Successful operation
Hide response attributes Show response attributes object
- total_clicks object
  
  Key-value map of country codes and total number of clicks for that country
- suspicious_clicks object
  
  Key-value map of country codes and number of suspicious clicks for that country
- flagged_clicks object
  
  Key-value map of country codes and number of flagged clicks for that country
- invalid_clicks object
  
  Key-value map of country codes and number of invalid clicks for that country

GET /accounts/{account_id}/geo

curl \
 -X GET https://api.clickguard.com/accounts/{account_id}/geo?period=TODAY \
 -H "X-API-KEY: $API_KEY"

Response examples (200)

"{\n  \"total_clicks\": {\n    \"US\": 89,\n    \"GB\": 28,\n    \"AU\": 19,\n    \"NL\": 10,\n    \"CA\": 10,\n    ...\n  },\n  \"suspicious_clicks\": {},\n  \"flagged_clicks\": {\n    \"US\": 15,\n    \"GB\": 5,\n    \"AU\": 1,\n    \"NL\": 3,\n    \"TR\": 2,\n    ...\n  },\n  \"invalid_clicks\": {\n    \"US\": 12,\n    \"AU\": 2\n  }\n}"

Response examples (200)

{
  "total_clicks": {},
  "suspicious_clicks": {},
  "flagged_clicks": {},
  "invalid_clicks": {}
}