Skip to main content
Version: 25.03

Performance Monitoring - Change Status

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/apm/change-status

Overview​

Mutes or reopens the issue status of a network or device trace.

Authentication​

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

Permissions​

Requires performance_monitoring Update permission.

Request Parameters​

ParameterTypeRequiredDescription
app_idStringYesApplication ID.
idStringYesTrace ID, as returned in the id field of traces by the Performance Monitoring read endpoints (for example /o/apm/network, /o/apm/device and /o/apm/issues).
typeStringYesTrace type: network or device.
statusStringYesopen or mute.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

Examples​

Mute a device trace​

/i/apm/change-status?
app_id=6991c75b024cb89cdc04efd2&
api_key=YOUR_API_KEY&
type=device&
id=TRACE_ID&
status=mute

Response​

Success Response​

{
"result": "Issue updated"
}

Response Fields​

FieldTypeDescription
resultStringResult message.

Error Responses​

  • 400
{
"result": "Unacceptable trace type"
}
  • 400
{
"result": "APM id not provided"
}
  • 400
{
"result": "Valid status not provided"
}

Behavior​

  • Updates the status stored for the trace identified by id and type.
  • Writes an apm_edited system log entry with the trace settings before the change and the update.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.apmTrace propertiesSets status on the trace property document <app_id>_<type>_<name>_props.