Skip to main content

/i/app_users/deleteExport/\{id\}

Endpoint

/i/app_users/deleteExport/\{id\}

Overview

Delete an existing app-user export artifact.

Authentication

  • API Key (parameter): api_key=YOUR_API_KEY
  • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
  • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions

  • Requires write-level app access.

Request Parameters

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)Dashboard API authentication key.
auth_tokenStringYes (or use api_key)Dashboard auth token.
app_idStringYesTarget app ID for permission validation.
idStringYesExport file identifier from path segment.

Response

Success Response

{
"result": "Export deleted"
}

Response Fields

FieldTypeDescription
resultStringExport deletion status.

Error Responses

Status Code: 400 Bad Request

{
"result": "invalid filename"
}

Status Code: 400 Bad Request

{
"result": "Invalid filename"
}

Status Code: 400 Bad Request

{
"result": "There was some errors during deleting export. Please look in log for more information"
}

Status Code: 401 Unauthorized

{
"result": "No app_id provided"
}

Status Code: 400 Bad Request

{
"result": "Missing parameter \"api_key\" or \"auth_token\""
}

Behavior/Processing

Behavior Modes

ModeTriggerProcessing PathResponse Shape
Single-user export cleanupid matches appUser_\{appId\}_{uid}Deletes export artifacts and unsets appUserExport on matching user.Wrapped string: { "result": "Export deleted" }
Multi-user/hash export cleanupid matches hash export formatDeletes export artifacts without user-profile field update.Wrapped string: { "result": "Export deleted" }
Invalid filenameid format does not match expected prefixRequest is rejected before cleanup.Wrapped error string: { "result": "invalid filename" }

Impact on Other Data

  • Removes export payload records from countly.exports.
  • For single-user exports, updates countly.app_users\{appId\} to remove stored appUserExport path.

Audit & System Logs

ActionTriggerPayload
export_app_user_deletedSuccessful export deletion{ result, id, app_id, info } (plus uids for single-user export IDs)

Database Collections

CollectionUsed forData touched by this endpoint
countly.membersAuthentication and permission validationReads member identity and app-level write permissions.
countly.exportsExport payload cleanupDeletes records where _eid matches the export identifier.
countly.app_users\{appId\}Single-user export metadata cleanupUnsets appUserExport when the deleted export belongs to one user.
countly_fsExport archive cleanupDeletes archive objects from GridFS appUsers bucket when present.

Examples

Example 1: Delete export

/i/app_users/deleteExport/appUser_64b0ac10c2c3ce0012dd1001_1?api_key=YOUR_API_KEY&app_id=64b0ac10c2c3ce0012dd1001
{
"result": "Export deleted"
}

Limitations

  • id must follow expected export naming format.

Last Updated

2026-02-17