Skip to main content

Reports - Report Status Update

Endpoint​

/i/reports/status

Overview​

Updates enabled status for one or more reports in a bulk operation.

Authentication​

Countly API supports three authentication methods:

  1. api_key=YOUR_API_KEY
  2. auth_token=YOUR_AUTH_TOKEN
  3. countly-token: YOUR_AUTH_TOKEN

Permissions​

Requires reports Update 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)YesStatus map where keys are report IDs and values are booleans.
args.[reportId]BooleanYestrue to enable, false to disable.

Response​

Success Response​

{
  "result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringSuccess when bulk execution branch completes without MongoDB error.

Error Responses​

  • 200
{
  "result": "database error text"
}

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

Behavior/Processing​

  • Parses args JSON before route execution.
  • Builds unordered bulk operation on countly.reports.
  • For each key in args, applies update { $set: { enabled: args[id] } }.
  • Executes bulk only when at least one operation exists.

Impact on Other Data​

  • Updates enabled field on report documents in countly.reports.

Database Collections​

CollectionUsed forData touched by this endpoint
countly.reportsReport storageBulk updates enabled field for provided report IDs.

Examples​

Disable two reports in one call​

/i/reports/status?
  api_key=YOUR_API_KEY&
  app_id=6991c75b024cb89cdc04efd2&
  args={"6262742dbf7392a8bfd8c1f6":false,"6262742dbf7392a8bfd8c1f7":false}

Limitations​

  • Endpoint does not return a response when args is empty ({}), because no bulk operation is executed.
  • This endpoint updates by report ID only and does not apply ownership filter inside the update query.

Last Updated​

2026-03-07