Skip to main content

Delete formula

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/i/calculated_metrics/delete

Overview

Deletes a formula by ID.

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

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.

Examples

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

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

  • 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.
Implementation details

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.