Skip to main content

Views - Delete

Endpoint

/i/views?method=delete_view

Overview

Deletes one or more views and removes associated aggregated/user-level view data plus related drill action/view records.

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 views Delete permission.

Request Parameters

ParameterTypeRequiredDescription
methodStringYesMust be delete_view.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.
app_idStringYesTarget app ID.
view_idStringYesComma-separated list of view IDs to delete.

Response

Success Response

{
"result": true
}

Response Fields

FieldTypeDescription
resultBooleantrue when delete flow completes; false if caught exception path is used.

Error Responses

  • 400
{
"result": "Missing parameter \"api_key\" or \"auth_token\""
}
  • 401
{
"result": "User does not have right"
}

Behavior/Processing

Behavior Modes

ModeTriggerProcessing PathResponse Shape
Delete successDelete loop completesRemoves metadata/data entries for each listed view and dispatches cleanup hooks.Raw object: { "result": true }
Delete failureException in delete flowStops in catch path and returns failure flag.Raw object: { "result": false }

Impact on Other Data

  • Removes matching view rows from countly.app_viewdata and countly.app_viewsmeta.
  • Runs $unset on a literal viewid field in user-view maps in countly.app_userviews and countly.app_userviews{appId}.
  • Dispatches granular deletes for [CLY]_view and [CLY]_action in drill events.
  • Dispatches /view/delete hook for downstream cleanup in other features.

Database Collections

CollectionUsed forData touched by this endpoint
countly.membersAuthentication and permission checksReads member account and access rights for delete validation.
countly.appsApp validation/context loadingValidates app_id for delete scope.
countly.viewsView root metadata lookupReads app-level views root document before delete operations.
countly.app_viewsmetaView metadata deletionDeletes metadata entries for removed view IDs.
countly.app_viewdataAggregated view metric deletionDeletes metric docs matching removed view IDs (vw).
countly.app_userviewsUser-view map cleanup (main)Unsets deleted view fields from user view map documents.
countly.app_userviews{appId}User-view map cleanup (legacy app collection)Unsets deleted view fields from legacy user view map documents.
countly_drill.drill_eventsGranular event cleanupDeletes [CLY]_view and [CLY]_action records linked to deleted views.

Examples

Delete one view

/i/views?
method=delete_view&
api_key=YOUR_API_KEY&
app_id=6991c75b024cb89cdc04efd2&
view_id=6991c75b024cb89cdc04efd2_home

Delete multiple views

/i/views?
method=delete_view&
api_key=YOUR_API_KEY&
app_id=6991c75b024cb89cdc04efd2&
view_id=6991c75b024cb89cdc04efd2_home,6991c75b024cb89cdc04efd2_checkout

Operational Considerations

  • Deletion is destructive and cannot be reversed.
  • Multi-view requests run per-view cleanup in sequence of async operations; partial cleanup can occur if a later step fails.

Limitations

  • view_id must be passed as a comma-separated string, not an array parameter.

Last Updated

2026-02-17