Surveys - Delete Survey

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/surveys/survey/delete

Deletes a Survey widget. Optionally removes linked response data.

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

Parameter	Type	Required	Description
`api_key`	String	Yes (or `auth_token`)	API key authentication
`auth_token`	String	Yes (or `api_key`)	Auth token authentication
`app_id`	String	Yes	App ID
`widget_id`	String	Yes	Widget ID
`with_data`	Boolean/String	No	Also remove widget response data

/i/surveys/survey/delete?api_key=YOUR_API_KEY&app_id=YOUR_APP_ID&widget_id=67b9db56f67aab0012cd8899

{
  "result": "Success"
}

Field	Type	Description
`result`	String	Delete status

{
  "result": "Widget not found"
}

Loads the widget from feedback_widgets by widget_id; missing widgets return Widget not found.
Deletes the widget logo file when appearance.logo is set.
Removes the widget document from feedback_widgets.
Deletes the linked cohort when cohortID exists.
If with_data is set, also removes related widget response/aggregate data; success emits surveys_removed_with_data.
Without with_data, only the widget record is removed; success emits surveys_widget_removed.

Implementation details

Database Collections

Collection	Used for	Data touched by this endpoint
`countly.feedback_widgets`	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.
`countly.cohorts`	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.
`countly_drill.drill_events`	Drill event records	Stores granular event rows queried or updated by this endpoint.