Skip to main content

Reports - Report Delete

Endpoint​

/i/reports/delete

Overview​

Deletes a report definition.

Authentication​

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

Permissions​

Requires reports Delete permission.

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.
app_idStringYesApp ID used by permission validation.
argsString (JSON Object)YesMust include report _id.
args._idStringYesTarget report ID.

Examples​

Delete one report​

/i/reports/delete?
api_key=YOUR_API_KEY&
app_id=6991c75b024cb89cdc04efd2&
args={"_id":"6262742dbf7392a8bfd8c1f6"}

Response​

Success Response​

{
"result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringSuccess when delete operation finishes.

Error Responses​

  • 200
{
"result": "Not enough args"
}
  • 200
{
"result": "Error deleting report"
}

Standard authentication/authorization errors from delete validation can also be returned.

Behavior​

  • Parses args JSON before route execution.
  • Validates _id format before deleting.
  • Uses owner-scoped query for non-global-admin users.
  • Reads report for audit payload, then removes it from countly.reports.
  • If report existed, emits reports_deleted system log action.

Impact on Other Data​

  • Removes one report document from countly.reports.
  • Adds one audit entry in countly.systemlogs when deleted report document is found.

Limitations​

  • Endpoint can return Success even when no matching report was found/removed.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.reportsReport storageReads and removes target report document.
countly.systemlogsAudit trailReceives reports_deleted action for existing report deletions.