Skip to main content
Version: 26.01

Performance Monitoring - Read Overview

Endpoint​

/o/apm/overview

Overview​

Returns the network and device traces of an app together with overview data: network success rate, network latency by country, and the slowest networks. Mobile apps also get the slowest screens and app start 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.
app_typeStringYesApplication type: web or mobile.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

Examples​

Read the overview of a mobile app​

/o/apm/overview?
  app_id=6991c75b024cb89cdc04efd2&
  api_key=YOUR_API_KEY&
  app_type=mobile

Response​

Success Response​

{
  "network_traces": [
    {
      "name": "example.com/demo/",
      "id": "TRACE_ID",
      "data": {
        "response_code": 100,
        "response_time": 106
      }
    }
  ],
  "device_traces": {
    "duration_traces": [
      {
        "name": "for_loop",
        "id": "TRACE_ID",
        "data": {
          "duration": 2000
        }
      }
    ],
    "page_load_traces": []
  },
  "overview": {
    "success_rate": {
      "metric": "response_code",
      "data": {
        "response_code": {
          "2022.4.7": 100
        }
      }
    },
    "network_latency": [
      {
        "cc": "TR",
        "data": {
          "response_time": 375
        },
        "breakdown": {
          "below": 3,
          "between": 0,
          "above": 0
        }
      }
    ],
    "slow_networks": []
  }
}

Response Fields​

FieldTypeDescription
network_tracesArrayNetwork traces, slowest response time first.
device_tracesObjectDevice traces grouped by kind. Web apps do not get screen_traces; mobile apps do not get page_load_traces.
overview.success_rateObjectNetwork success rate over time.
overview.network_latencyArrayResponse time and breakdown (below, between, above) per country code, as in Performance Monitoring - Read Network Latency Breakdown.
overview.slow_networksArrayThe first 5 entries of network_traces.
overview.slow_screensArrayMobile apps only. The first 5 slow rendering screens.
overview.app_startObjectMobile apps only. App start trace.

Error Responses​

  • 400
{
  "result": "App type not provided"
}

Behavior​

  • Network traces use the metrics response_time and response_code.
  • Device traces use duration, slow_rendering_frames and frozen_frames; for web apps they use duration, first_paint and first_contentful_paint.