Get IP reports

GET /accounts/{account_id}/reports/ips

Fetch reports for the observed IP addresses 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 IPs by given query
ips[] array[string]

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

Status of an IP address

Values are NORMAL, SUSPICIOUS, or BLOCKED.

Responses

200

Successful operation
Hide response attributes Show response attributes array[object]
- ip string
  
  IP address
- ip_type number
  
  Version of the IP address, can be 4 or 6
- status string
  
  The current status of the IP address
- total_clicks number
  
  Total number of clicks from this IP
- normal_clicks number
  
  Total number of normal clicks from this IP
- suspicious_clicks number
  
  Total number of suspicious clicks from this IP
- flagged_clicks number
  
  Total number of flagged clicks from this IP
- invalid_clicks number
  
  Total number of invalid clicks from this IP
- first_seen string(date-time)
  
  Timestamp of the first occurrence of this IP
- last_seen string(date-time)
  
  Timestamp of the last occurrence of this IP
- last_campaign_id string
  
  The ID of the last campaign this IP interacted with
- last_device_id string
  
  The ID of the last device this IP was reported with
- last_country string
  
  The last country this IP was reported from
- last_city string
  
  The last city this IP was reported from

GET /accounts/{account_id}/reports/ips

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

Response examples (200)

"[\n  {\n    \"ip\": \"123.211.211.150\",\n    \"ip_type\": \"4\",\n    \"status\": \"BLOCKED\",\n    \"total_clicks\": 12,\n    \"normal_clicks\": 2,\n    \"invalid_clicks\": 4,\n    \"suspicious_clicks\": 1,\n    \"flagged_clicks\": 5,\n    \"first_seen\": \"2021-01-14T13:13:01.511Z\",\n    \"last_seen\": \"2021-03-02T16:22:34.556Z\",\n    \"last_campaign_id\": \"9263669976\",\n    \"last_device_id\": null,\n    \"last_country\": \"Australia\",\n    \"last_city\": \"Sunshine Coast\"\n  },\n  ...\n]"

Response examples (200)

[
  {
    "ip": "string",
    "ip_type": 42.0,
    "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_device_id": "string",
    "last_country": "string",
    "last_city": "string"
  }
]