Skip to main content

Delete formula

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

Endpoint​

/i/calculated_metrics/delete

Overview​

Deletes a formula by ID.

Authentication​

Countly API supports three authentication methods:

  1. API key query parameter: api_key=YOUR_API_KEY
  2. Auth token query parameter: auth_token=YOUR_AUTH_TOKEN
  3. Auth token header: countly-token: YOUR_AUTH_TOKEN

Permissions​

Requires formulas Delete permission.

Request Parameters​

ParameterTypeRequiredDescription
app_idStringYesTarget app ID.
idStringYesFormula ID to delete.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

Response​

Success Response​

{
  "result": "Deleted a formula"
}

Response Fields​

FieldTypeDescription
resultStringDeletion outcome message.

Error Responses​

  • 200
{
  "result": "Don't have permission to delete formula"
}
  • 500
{
  "result": "Failed to delete the formula"
}

Behavior/Processing​

  • Applies visibility-based condition (global, owner, shared email) together with _id and app.
  • If a matching formula is found, endpoint removes it and returns Deleted a formula.
  • If no matching formula is found, endpoint returns Don't have permission to delete formula with status 200.
  • Dispatches deletion events for system logs and formula cleanup hooks.
  • Triggers dashboard cleanup for widgets that reference the deleted formula.

Database Collections​

CollectionUsed forData touched by this endpoint
countly.calculated_metricsEndpoint data sourceStores endpoint-related records this endpoint reads or modifies.
countly.systemlogsAudit trailContains system action records used by this endpoint for audit output or audit writes.
countly.widgetsEndpoint data sourceStores endpoint-related records this endpoint reads or modifies.

Examples​

/i/calculated_metrics/delete?
  app_id=64f5c0d8f4f7ac0012ab3456&
  id=67bd31c92e7f0b0012ab4567

Last Updated​

2026-02-16