Application Metrics

The metrics endpoint can be used to get information about your application's analytics such as the bandwidth, build time, average response request and more.

Bandwidth

Total data that is transmitted in the selected time period.

SecuritybearerAuth

Request

path Parameters

required

string

Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1

query Parameters

interval_in_seconds required	integer Example: interval_in_seconds=3600
timeframe_start required	string <date-time> Example: timeframe_start=2021-07-22T18:10:45.511Z
timeframe_end required	string <date-time> Example: timeframe_end=2021-07-22T18:10:45.511Z

Responses

200

Successfully retrieved application bandwidth.

400

One or more of the required parameters were not provided to the request

401

No or invalid API key provided to the request

404

No application or database found with the provided unique ID.

500

Error occurred while retrieving application bandwidth

get/applications/{id}/metrics/bandwidth

Request samples

curl
Node.js
Browser JavaScript
PHP

Response samples

application/json

{"app": {"id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
"display_name": "my-app",
"metrics": {"timeframe": {"start": "1679587045511",
"end": "1679587045511"
},
"bandwidth": [{"time": "1679587045511",
"value": "value"
}
]
}
}
}

Build Time

Total time your application has taken to be built.

SecuritybearerAuth

Request

path Parameters

required

string

Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1

query Parameters

interval_in_seconds required	integer Example: interval_in_seconds=3600
timeframe_start required	string <date-time> Example: timeframe_start=2021-07-22T18:10:45.511Z
timeframe_end required	string <date-time> Example: timeframe_end=2021-07-22T18:10:45.511Z

Responses

200

Successfully retrieved application build time.

400

One or more of the required parameters were not provided to the request

401

No or invalid API key provided to the request

404

No application or database found with the provided unique ID.

500

Error occurred while retrieving application build time

get/applications/{id}/metrics/build-time

Request samples

curl
Node.js
Browser JavaScript
PHP

Response samples

application/json

{"app": {"id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
"display_name": "my-app",
"metrics": {"timeframe": {"start": "1679587045511",
"end": "1679587045511"
},
"build_time": [{"data": [{"time": "1679587045511",
"value": 127
}
],
"resource_type": "standard"
}
]
}
}
}

Run Time

Total time the application is running after being built and deployed.

SecuritybearerAuth

Request

path Parameters

required

string

Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1

query Parameters

interval_in_seconds required	integer Example: interval_in_seconds=3600
timeframe_start required	string <date-time> Example: timeframe_start=2021-07-22T18:10:45.511Z
timeframe_end required	string <date-time> Example: timeframe_end=2021-07-22T18:10:45.511Z

Responses

200

Successfully retrieved application run time.

400

One or more of the required parameters were not provided to the request

401

No or invalid API key provided to the request

404

No application or database found with the provided unique ID.

500

Error occurred while retrieving application build time

get/applications/{id}/metrics/run-time

Request samples

curl
Node.js
Browser JavaScript
PHP

Response samples

application/json

{"app": {"id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
"display_name": "my-app",
"metrics": {"timeframe": {"start": "1679587045511",
"end": "1679587045511"
},
"runtime": [{"process_id": "1679587045511",
"seconds": "43223",
"plan": "s1",
"start_time": "1679587045511",
"end_time": "1679587045511"
}
]
}
}
}

HTTP Requests per Minute

Total average requests per minute.

SecuritybearerAuth

Request

path Parameters

required

string

Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1

query Parameters

interval_in_seconds required	integer Example: interval_in_seconds=3600
timeframe_start required	string <date-time> Example: timeframe_start=2021-07-22T18:10:45.511Z
timeframe_end required	string <date-time> Example: timeframe_end=2021-07-22T18:10:45.511Z

Responses

200

Successfully retrieved application average HTTP requests.

400

One or more of the required parameters were not provided to the request

401

No or invalid API key provided to the request

404

No application or database found with the provided unique ID.

500

Error occurred while retrieving application average HTTP requests

get/applications/{id}/metrics/http-requests

Request samples

curl
Node.js
Browser JavaScript
PHP

Response samples

application/json

{"app": {"id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
"display_name": "my-app",
"metrics": {"timeframe": {"start": "1679587045511",
"end": "1679587045511"
},
"http_requests": [{"time": "1679587045511",
"value": "value"
}
]
}
}
}

Average Response Time

Average request response time. If "percent" is set, the P50 or P95 response time will be returned.

SecuritybearerAuth

Request

path Parameters

required

string

Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1

query Parameters

interval_in_seconds required	integer Example: interval_in_seconds=3600
timeframe_start required	string <date-time> Example: timeframe_start=2021-07-22T18:10:45.511Z
timeframe_end required	string <date-time> Example: timeframe_end=2021-07-22T18:10:45.511Z
percent	integer The percentile of slowest requests to return (e.g. 95 means we return the average of the 5% slowest requests) Enum: 50 95 Example: percent=95 Find more information about supported percentiles

Responses

200

Successfully retrieved application average response time.

400

One or more of the required parameters were not provided to the request

401

No or invalid API key provided to the request

404

No application or database found with the provided unique ID.

500

Error occurred while retrieving application average response time

get/applications/{id}/metrics/response-time

Request samples

curl
Node.js
Browser JavaScript
PHP

Response samples

application/json

{"app": {"id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
"display_name": "my-app",
"metrics": {"timeframe": {"start": "1679587045511",
"end": "1679587045511"
},
"response_time": [{"time": "1679587045511",
"value": "977"
}
]
}
}
}

Slowest Requests

Slowest response shows you exactly which responses are the slowest on your application.

SecuritybearerAuth

Request

path Parameters

required

string

Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1

query Parameters

interval_in_seconds required	integer Example: interval_in_seconds=3600
timeframe_start required	string <date-time> Example: timeframe_start=2021-07-22T18:10:45.511Z
timeframe_end required	string <date-time> Example: timeframe_end=2021-07-22T18:10:45.511Z
limit	integer Default: 10 Example: limit=10

Responses

200

Successfully retrieved application slowest requests.

400

One or more of the required parameters were not provided to the request

401

No or invalid API key provided to the request

404

No application or database found with the provided unique ID.

500

Error occurred while retrieving application slowest requests.

get/applications/{id}/metrics/slowest-requests

Request samples

curl
Node.js
Browser JavaScript
PHP

Response samples

application/json

{"app": {"id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
"display_name": "my-app",
"metrics": {"timeframe": {"start": "1679587045511",
"end": "1679587045511"
},
"response_time": [{"time": "1679587045511",
"value": "977"
}
],
"slowest_requests": [{"avg_response_time_ms": 120,
"client_request_path": "/api",
"request_count": 100
}
]
}
}
}

CPU Usage

An average of the total CPU usage for the selected time period, as a percentage of instance’s CPU resources.

SecuritybearerAuth

Request

path Parameters

required

string

Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1

query Parameters

interval_in_seconds required	integer Example: interval_in_seconds=3600
timeframe_start required	string <date-time> Example: timeframe_start=2021-07-22T18:10:45.511Z
timeframe_end required	string <date-time> Example: timeframe_end=2021-07-22T18:10:45.511Z

Responses

200

Successfully retrieved application CPU usage.

400

One or more of the required parameters were not provided to the request

401

No or invalid API key provided to the request

404

No application or database found with the provided unique ID.

500

Error occurred while retrieving application CPU usage

get/applications/{id}/metrics/cpu-usage

Request samples

curl
Node.js
Browser JavaScript
PHP

Response samples

application/json

{"app": {"id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
"app_name": "my-app",
"processes": [{"id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
"process_name": "web",
"cpu_limit": 1,
"metrics": {"timeframe": {"start": "1679587045511",
"end": "1679587045511"
},
"cpu_usage": [{"time": "1679587045511",
"value": "value"
}
]
}
}
]
}
}

Memory Usage

An average of the total Memory (RAM) usage for the selected time period.

SecuritybearerAuth

Request

path Parameters

required

string

Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1

query Parameters

interval_in_seconds required	integer Example: interval_in_seconds=3600
timeframe_start required	string <date-time> Example: timeframe_start=2021-07-22T18:10:45.511Z
timeframe_end required	string <date-time> Example: timeframe_end=2021-07-22T18:10:45.511Z

Responses

200

Successfully retrieved application memory usage.

400

One or more of the required parameters were not provided to the request

401

No or invalid API key provided to the request

404

No application or database found with the provided unique ID.

500

Error occurred while retrieving application memory usage

get/applications/{id}/metrics/memory-usage

Request samples

curl
Node.js
Browser JavaScript
PHP

Response samples

application/json

{"app": {"id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
"app_name": "my-app",
"processes": [{"id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
"process_name": "web",
"memory_limit": 1,
"metrics": {"timeframe": {"start": "1679587045511",
"end": "1679587045511"
},
"memory_usage": [{"time": "1679587045511",
"value": "value"
}
]
}
}
]
}
}

➔ Next to Application Processes