User behavior stats

GET /accounts/{account_id}/behavior

Fetch statistics regarding user behavior on the website

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_device_clicks number
  
  Number of clicks with post-click data obtained with tracking code
- total_no_device_clicks number
  
  Number of clicks without post-click data
- high_interaction_clicks number
  
  Number of clicks with high user interaction level
- med_interaction_clicks number
  
  Number of clicks with medium user interaction level
- low_interaction_clicks number
  
  Number of clicks with low user interaction level
- no_interaction_clicks number
  
  Number of clicks with no user interaction
- high_bot_probability_clicks number
  
  Number of clicks with high bot probability
- med_bot_probability_clicks number
  
  Number of clicks with medium bot probability
- low_bot_probability_clicks number
  
  Number of clicks with low bot probability
- converted_clicks number
  
  Number of clicks that converted
- average_page_views number
  
  Average page views per user session
- average_time_on_site number
  
  Average time on site per user session in milliseconds
- bounce_rate number
  
  Average bounce rate

GET /accounts/{account_id}/behavior

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

Response examples (200)

"{\n  \"total_device_clicks\": 189,\n  \"total_no_device_clicks\": 65,\n  \"high_interaction_clicks\": 64,\n  \"med_interaction_clicks\": 37,\n  \"low_interaction_clicks\": 20,\n  \"no_interaction_clicks\": 54,\n  \"high_bot_probability_clicks\": 6,\n  \"low_bot_probability_clicks\": 159,\n  \"converted_clicks\": 16,\n  \"average_page_views\": 1.63,\n  \"average_time_on_site\": 247568.73,\n  \"bounce_rate\": 25.59\n}"

Response examples (200)

{
  "total_device_clicks": 42.0,
  "total_no_device_clicks": 42.0,
  "high_interaction_clicks": 42.0,
  "med_interaction_clicks": 42.0,
  "low_interaction_clicks": 42.0,
  "no_interaction_clicks": 42.0,
  "high_bot_probability_clicks": 42.0,
  "med_bot_probability_clicks": 42.0,
  "low_bot_probability_clicks": 42.0,
  "converted_clicks": 42.0,
  "average_page_views": 42.0,
  "average_time_on_site": 42.0,
  "bounce_rate": 42.0
}