---
title: "Retrieve home page metrics"
method: GET
path: "/api/engine/home-metrics"
tags: ["Engine"]
---

# Retrieve home page metrics

`GET /api/engine/home-metrics`

Returns the metrics displayed on the home page: the engine metrics and the metrics of every north and south connector

## Response `200`

The engine, north and south connector metrics

- HomeMetrics — Home metrics containing metrics for norths, souths, and the engine.
  - `norths` RecordStringNorthConnectorMetrics, required — Construct a type with a set of properties K of type T
  - `engine` EngineMetrics, required — Metrics for the engine.
    - `metricsStart` string, required — Represents an instant in time as an ISO 8601 string.
    - `processCpuUsageInstant` number, double, required — The instantaneous CPU usage of the process.
    - `processCpuUsageAverage` number, double, required — The average CPU usage of the process.
    - `processUptime` number, double, required — The uptime of the process in seconds.
    - `freeMemory` number, double, required — The amount of free memory in bytes.
    - `totalMemory` number, double, required — The total amount of memory in bytes.
    - `minRss` number, double, required — The minimum resident set size in bytes.
    - `currentRss` number, double, required — The current resident set size in bytes.
    - `maxRss` number, double, required — The maximum resident set size in bytes.
    - `minHeapTotal` number, double, required — The minimum heap total size in bytes.
    - `currentHeapTotal` number, double, required — The current heap total size in bytes.
    - `maxHeapTotal` number, double, required — The maximum heap total size in bytes.
    - `minHeapUsed` number, double, required — The minimum heap used size in bytes.
    - `currentHeapUsed` number, double, required — The current heap used size in bytes.
    - `maxHeapUsed` number, double, required — The maximum heap used size in bytes.
    - `minExternal` number, double, required — The minimum external memory size in bytes.
    - `currentExternal` number, double, required — The current external memory size in bytes.
    - `maxExternal` number, double, required — The maximum external memory size in bytes.
    - `minArrayBuffers` number, double, required — The minimum ArrayBuffers size in bytes.
    - `currentArrayBuffers` number, double, required — The current ArrayBuffers size in bytes.
    - `maxArrayBuffers` number, double, required — The maximum ArrayBuffers size in bytes.
  - `souths` RecordStringSouthConnectorMetrics, required — Construct a type with a set of properties K of type T

## Changes

- **2026-09-29** `493f2fb6bdac` — 1 info
  - endpoint added
- **2026-09-28** `62adb78789a0` — 1 breaking
  - api path removed without deprecation
- **2026-09-25** `abbc8a87e02a` — 1 info
  - endpoint added
- **2026-09-25** `5460a4ab68ba` — 1 breaking
  - api path removed without deprecation
- **2026-09-25** `6bde5d8e7c6f` — 1 info
  - endpoint added

[Full history](https://skmtc.dev/optimistiksas/apis/oibus-api/changes/api/engine/home-metrics/get.md)

---

[API](https://skmtc.dev/optimistiksas/apis/oibus-api.md) · [All operations](https://skmtc.dev/optimistiksas/apis/oibus-api/llms.txt) · [OpenAPI document](https://skmtc.dev/optimistiksas/apis/oibus-api/revisions/fa9a57387b34?raw)