Skip to main content
Version: 25.03

Performance Monitoring - Device Trace Read

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​

/o/apm/device

Overview​

Returns the aggregated and over-time metrics of one 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 Read permission.

Request Parameters​

ParameterTypeRequiredDescription
app_idStringYesApplication ID.
idStringYesTrace ID, as returned in the id field of traces by Overview Read.
periodString or ArrayNoPeriod of the data. Defaults to 30days.
bucketStringNohourly returns the over-time data per hour; otherwise it is returned per day.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

Examples​

Read a device trace​

/o/apm/device?
  app_id=6991c75b024cb89cdc04efd2&
  api_key=YOUR_API_KEY&
  id=TRACE_ID&
  period=30days

Response​

Success Response​

{
  "trace": "for_loop",
  "aggregate": {
    "name": "for_loop",
    "id": "739782df7973fc5ccb5cbecf32566ca0:116623a584addc571e16efe886546393",
    "data": {
      "duration": [2000, 2000, 2000]
    }
  },
  "overTime": {
    "name": "for_loop",
    "id": "739782df7973fc5ccb5cbecf32566ca0:116623a584addc571e16efe886546393",
    "data": {
      "duration": {
        "2022.4.7": [2000, 2000, 2000]
      }
    }
  },
  "metrices": {
    "duration": true
  }
}

Response Fields​

FieldTypeDescription
traceStringName of the trace.
aggregateObjectAggregated metrics of the trace over the period, with name, id and data. Empty if there is no data.
overTimeObjectMetrics of the trace per day (or per hour), with name, id and data. Empty if there is no data.
metricesObjectMetrics recorded for the trace.

Error Responses​

  • 400
{
  "result": "Device trace id not provided"
}