Skip to main content

Filtering Rules - Toggle Status

Endpoint​

/i/blocks/toggle_status

Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview​

Enables or disables one or more existing filtering rules.

Authentication​

Authentication Methods:

  • API Key (parameter): api_key=YOUR_API_KEY
  • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
  • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions​

  • Filtering Rules: Update permission (or global admin equivalent).

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringYes (or auth_token)API key authentication
auth_tokenStringYes (or api_key)Auth token authentication
app_idStringYesApplication ID
blocksStringYesStringified JSON object in { "ruleId": true/false } form

Response​

Success Response​

{
  "result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringOperation status

Error Responses​

  • HTTP 400 - Missing app ID:
{
  "result": "Provide app_id"
}
  • HTTP 400 - Missing/invalid block object:
{
  "result": "Provide block object"
}
  • HTTP 400 - Toggle failure:
{
  "result": "Error adding rule"
}
  • HTTP 400 - Missing auth params:
{
  "result": "Missing parameter \"api_key\" or \"auth_token\""
}
  • HTTP 401 - Auth/user validation failed:
{
  "result": "User does not exist"
}

Behavior/Processing​

  1. Validates app_id and update permission.
  2. Parses blocks map.
  3. Updates status for each provided rule ID.

Database Collections​

CollectionUsed forData touched by this endpoint
countly.appsApp configuration and metadataStores app-level feature settings and metadata used or modified by this endpoint.

Examples​

Example: Enable one rule and disable another​

curl "https://your-server.com/i/blocks/toggle_status?api_key=YOUR_API_KEY&app_id=YOUR_APP_ID&blocks=%7B%22rule1%22%3Atrue%2C%22rule2%22%3Afalse%7D"

Ⓔ Enterprise​

This feature is part of Countly Enterprise.

Get Access:

Already a Customer? Use support portal if you have any questions.

Last Updated​

2026-02-15​

Last Updated​

2026-02-16