Skip to main content

Delete funnel

Endpoint

/i/funnels/delete

Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview

Deletes a funnel definition.

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 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.

Response

Success Response

{
"result": "Success"
}

Response Fields

FieldTypeDescription
resultStringDeletion result.

Error Responses

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

Behavior/Processing

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

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.

Examples

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


Last Updated

2026-02-16