Summary stats

GET /accounts/{account_id}/summary

Fetch summary of stats for the specific account

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 number

      Total number of clicks in the chosen period

    • normal_clicks number

      Total number of normal 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

    • unique_ips number

      Total number of recorded unique IP addresses in the chosen period
GET /accounts/{account_id}/summary 
curl \
 -X GET https://api.clickguard.com/accounts/{account_id}/summary?period=TODAY \
 -H "X-API-KEY: $API_KEY"
Response examples (200) 
"{\n  \"total_clicks\": 275,\n  \"normal_clicks\": 220,\n  \"suspicious_clicks\": 0,\n  \"flagged_clicks\": 37,\n  \"invalid_clicks\": 18,\n  \"unique_ips\": 239\n}"
Response examples (200) 
{
  "total_clicks": 42.0,
  "normal_clicks": 42.0,
  "suspicious_clicks": 42.0,
  "flagged_clicks": 42.0,
  "invalid_clicks": 42.0,
  "unique_ips": 42.0
}