Skip to main content
Version: 25.03

Delete funnel

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/funnels/delete

Overview​

Deletes a funnel definition.

Authentication​

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

Permissions​

Requires funnels Delete permission.

Request Parameters​

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

Examples​

/i/funnels/delete?
app_id=64f5c0d8f4f7ac0012ab3456&
funnel_id=67f1c22912df5acb8f8d5caaf0f89a31

Response​

Success Response​

{
"result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringDeletion result.

Error Responses​

  • 400
{
"result": "Not enough args"
}
  • 404
{
"result": "Funnel does not exist"
}

Behavior​

  • Validates required app_id and funnel_id.
  • Verifies funnel existence before deletion.
  • Deletes matching funnel document from funnels.
  • Triggers dashboard widget cleanup for deleted funnel references.
  • Writes funnel_deleted system log entry.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.funnelsEndpoint 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.