Device type stats

GET /accounts/{account_id}/devices

Fetch statistics regarding different device types

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 array[object]
- device_type string
  
  The device type referencing the stats
- total_clicks number
  
  Total number of clicks in the chosen period
- suspicious_clicks number
  
  Total number of suspicious clicks in the chosen period
- flagged_clicks number
  
  Total number of flagged clicks in the chosen period
- invalid_clicks number
  
  Total number of invalid clicks in the chosen period

GET /accounts/{account_id}/devices

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

Response examples (200)

"[\n  {\n    \"device_type\": \"computer\",\n    \"total_clicks\": 219,\n    \"suspicious_clicks\": 0,\n    \"flagged_clicks\": 32,\n    \"invalid_clicks\": 12\n  },\n  {\n    \"device_type\": \"mobile\",\n    \"total_clicks\": 31,\n    \"suspicious_clicks\": 0,\n    \"flagged_clicks\": 1,\n    \"invalid_clicks\": 1\n  },\n]"

Response examples (200)

[
  {
    "device_type": "string",
    "total_clicks": 42.0,
    "suspicious_clicks": 42.0,
    "flagged_clicks": 42.0,
    "invalid_clicks": 42.0
  }
]