Get rules

GET /accounts/{account_id}/rules

Fetch rules for the given account

Available on: AuditGUARD AlertGUARD PremiumGUARD EliteGUARD

Path parameters

Query parameters

  • active boolean

    Flag indicating if the rule is currently active

  • type string

    Optimization rule type

    Values are click-frequency, target-frequency, invalid-clicks, no-fingerprint, behavior, conversion, or click-intensity.

  • ids[] array[string]

    Fetch all rules for the given array of rule IDs.

Responses

  • 200

    Successful operation

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

      The unique identifier of the rule

    • type string

      The type of rule

      Values are click-frequency, target-frequency, no-fingerprint, behavior, invalid, or click-intensity.

    • name string

      Optimization rule name

    • active boolean

      Flag indicating if the rule is currently active

    • created_at string(date-time)

      Timestamp of the rule creation

    • updated_t string(date-time)

      Timestamp of the last update to the rule

    • activated_at string(date-time)

      Timestamp of when the rule was last activated

    • deactivated_at string(date-time)

      Timestamp of when the rule was last deactivated
GET /accounts/{account_id}/rules 
curl \
 -X GET https://api.clickguard.com/accounts/{account_id}/rules \
 -H "X-API-KEY: $API_KEY"
Response examples (200) 
"[\n  {\n    \"id\": \"rJ-fT14Md\",\n    \"type\": \"click-frequency\",\n    \"name\": \"Block non converting IPs\",\n    \"active\": true,\n    \"created_at\": \"2021-02-24T15:13:13.442Z\",\n    \"updated_at\": \"2021-02-24T15:13:13.442Z\",\n    \"activated_at\": \"2021-02-24T15:13:13.442Z\",\n    \"deactivated_at\": null\n  },\n  ...\n]"
Response examples (200) 
[
  {
    "id": "string",
    "type": "click-frequency",
    "name": "string",
    "active": true,
    "created_at": "2024-05-04T09:42:00+00:00",
    "updated_t": "2024-05-04T09:42:00+00:00",
    "activated_at": "2024-05-04T09:42:00+00:00",
    "deactivated_at": "2024-05-04T09:42:00+00:00"
  }
]