Performance Monitoring - Overview 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/overview
Overview
Returns the performance overview of an app: all network and device traces with their aggregated metrics, the success rate of network requests, and the network latency by country.
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
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | String | Yes | Application ID. |
app_type | String | Yes | Type of the app: web or mobile. |
period | String or Array | No | Period of the data. Defaults to 30days. |
api_key | String | Conditional | Required if auth_token is not provided. |
auth_token | String | Conditional | Required 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": [],
"device_traces": {},
"overview": {
"success_rate": {},
"network_latency": [],
"slow_networks": [],
"slow_screens": [],
"app_start": {}
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
network_traces | Array | All network traces with their aggregated metrics (response_time, response_code). Each trace has name, id and data. |
device_traces | Object | Device traces, grouped by kind. For web apps the duration, first paint and first contentful paint are aggregated; for mobile apps the duration, slow rendering frames and frozen frames. |
overview.success_rate | Object | Success rate of network requests. |
overview.network_latency | Array | Network latency by country, in the format of Network Latency Breakdown Read. |
overview.slow_networks | Array | The first five entries of network_traces. |
overview.slow_screens | Array | The first five slow-rendering screens. Only for mobile apps. |
overview.app_start | Object | App start trace. Only for mobile apps. |
Error Responses
400
{
"result": "App type not provided"
}
Behavior
- The trace
idvalues can be used in the other Performance Monitoring read endpoints.