Get rule reports

GET /accounts/{account_id}/reports/rules

Fetch reports for the observed rules in the given period

Available on: AuditGUARD AlertGUARD PremiumGUARD EliteGUARD

Path parameters

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 devices 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 rules by given query

  • ids[] array[string]

    Fetch all rule reports for the given array of rule IDs.

  • type string

    Search rules by rule type

Responses

  • 200

    Successful operation

    Hide response attributes Show response attributes array[object]
    • id string

      Optimization rule ID

    • name string

      Optimization rule name

    • active boolean

      Flag indicating if the rule is active

    • type string

      The rule type

    • created_at string(date-time)

      Timestamp of the first occurrence of this keyword

    • total_clicks number

      Total number of clicks for this keyword

    • normal_clicks number

      Total number of normal clicks for this keyword

    • suspicious_clicks number

      Total number of suspicious clicks for this keyword

    • flagged_clicks number

      Total number of flagged clicks for this keyword

    • invalid_clicks number

      Total number of invalid clicks for this keyword

    • first_seen string(date-time)

      Timestamp of the first occurrence of this keyword

    • last_seen string(date-time)

      Timestamp of the last occurrence of this keyword

    • observe_start string(date-time)

      Timestamp of when the rule started processing clicks

    • observe_end string(date-time)

      Timestamp of when the rule stopped processing clicks
GET /accounts/{account_id}/reports/rules 
curl \
 -X GET https://api.clickguard.com/accounts/{account_id}/reports/rules?period=TODAY \
 -H "X-API-KEY: $API_KEY"
Response examples (200) 
"{\n  \"id\": \"HJCPLMIIu\",\n  \"active\": true,\n  \"type\": \"behavior\",\n  \"name\": \"Low time on site [By ClickGUARD]\",\n  \"created_at\": \"2021-04-15T19:39:17.774Z\",\n  \"total_clicks\": 10,\n  \"suspicious_clicks\": 1,\n  \"flagged_clicks\": 3,\n  \"triggered_clicks\": 1,\n  \"action_clicks\": 1,\n  \"tagged_clicks\": 1,\n  \"notified_clicks\": 1,\n  \"total_initiated_exclusions\": 1,\n  \"total_successful_exclusions\": 1,\n  \"total_failed_exclusions\": 0,\n  \"observe_start\": \"2021-04-15T19:39:17.879Z\",\n  \"observe_end\": null,\n  \"first_seen\": \"2021-04-15T19:40:17.879Z\",\n  \"last_seen\": \"2021-04-16T11:39:07.879Z\",\n}"
Response examples (200) 
[
  {
    "id": "string",
    "name": "string",
    "active": true,
    "type": "string",
    "created_at": "2024-05-04T09:42:00+00:00",
    "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",
    "observe_start": "2024-05-04T09:42:00+00:00",
    "observe_end": "2024-05-04T09:42:00+00:00"
  }
]