Get IP ranges reports

GET /accounts/{account_id}/reports/ip-ranges

Fetch reports for the observed IP address ranges in the given period

Available on: AuditGUARD AlertGUARD PremiumGUARD EliteGUARD

Path parameters

account_id string Required

ID of an account

Query parameters

period string Required

Observed period for the report

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

Sort the IPs by a specified parameter. Use '-' prefix to indicate a descending sort. Default: '-total_clicks'.

Values are last_seen, first_seen, total_clicks, invalid_clicks, or flagged_clicks.
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.
query string

Search IP ranges by given query
ip-ranges[] array[string]

Fetch all IP range reports for the given array of IP ranges.
status string

Status of an IP range

Values are NORMAL, SUSPICIOUS, or BLOCKED.

Responses

200

Successful operation
Hide response attributes Show response attributes array[object]
- ip_range string
  
  CIDR notation of the IP range
- ip_wildcard string
  
  Wildcard notation of the IP range
- status string
  
  The current status of the IP range
- total_clicks number
  
  Total number of clicks from this IP range
- normal_clicks number
  
  Total number of normal clicks from this IP range
- suspicious_clicks number
  
  Total number of suspicious clicks from this IP range
- flagged_clicks number
  
  Total number of flagged clicks from this IP range
- invalid_clicks number
  
  Total number of invalid clicks from this IP range
- first_seen string(date-time)
  
  Timestamp of the first occurrence of this IP range
- last_seen string(date-time)
  
  Timestamp of the last occurrence of this IP range
- last_campaign_id string
  
  The ID of the last campaign this IP range interacted with
- last_country string
  
  The last country this IP range was reported from
- last_city string
  
  The last city this IP range was reported from

GET /accounts/{account_id}/reports/ip-ranges

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

Response examples (200)

"[\n  {\n    \"ip_range\": \"123.211.0.0/16\",\n    \"ip_wildcard\": \"123.211.*.*\",\n    \"status\": \"NORMAL\",\n    \"total_clicks\": 2,\n    \"normal_clicks\": 1,\n    \"invalid_clicks\": 1,\n    \"suspicious_clicks\": 0,\n    \"flagged_clicks\": 0,\n    \"first_seen\": \"2020-12-22T10:37:26.262Z\",\n    \"last_seen\": \"2021-03-02T16:22:34.573Z\",\n    \"last_campaign_id\": \"9263669976\",\n    \"last_country\": \"Australia\",\n    \"last_city\": \"Sunshine Coast\"\n  },\n  ...\n]"

Response examples (200)

[
  {
    "ip_range": "string",
    "ip_wildcard": "string",
    "status": "string",
    "total_clicks": 42.0,
    "normal_clicks": 42.0,
    "suspicious_clicks": 42.0,
    "flagged_clicks": 42.0,
    "invalid_clicks": 42.0,
    "first_seen": "2024-05-04T09:42:00+00:00",
    "last_seen": "2024-05-04T09:42:00+00:00",
    "last_campaign_id": "string",
    "last_country": "string",
    "last_city": "string"
  }
]