---
title: "Dashboard aggregate payload"
method: GET
path: "/dashboard"
tags: ["dashboard"]
---

# Dashboard aggregate payload

`GET /dashboard`

Returns combined dashboard counters, runtime metadata, and process state in one response.

## Response `200`

Successful operation

- Dashboard — Overview and runtime info in a single payload.
  - `appName` string, required — Application name reported by the binary.
  - `version` string, required — GripMock version.
  - `goVersion` string, required — Go version the binary was built with.
  - `compiler` string, required — Go compiler used for the build.
  - `goos` string, required — Operating system the binary targets.
  - `goarch` string, required — CPU architecture the binary targets.
  - `numCPU` integer, required — CPUs visible to the process.
  - `startedAt` string, date-time, required — When the process started (RFC 3339).
  - `uptimeSeconds` integer, required — Seconds since startup.
  - `ready` boolean, required — Whether the server has finished loading and is answering calls.
  - `historyEnabled` boolean, required — Whether call history recording is on (`HISTORY_ENABLED`).
  - `totalServices` integer, required — Services currently registered, from every descriptor source.
  - `totalStubs` integer, required — Stubs currently in storage.
  - `usedStubs` integer, required — Stubs matched at least once since startup.
  - `unusedStubs` integer, required — Stubs never matched since startup.
  - `coveredMethods` integer — Number of gRPC methods that have at least one stub
  - `totalMethods` integer — Total number of gRPC methods across all services
  - `grpcAddr` string — Native gRPC listen address
  - `gatewayAddr` string — ConnectRPC + gRPC-web listen address
  - `httpAddr` string — Admin REST API + UI listen address
  - `totalSessions` integer, required — Sessions currently known to the server.
  - `runtimeDescriptors` integer, required — Descriptors uploaded over REST since startup.
  - `totalHistory` integer, required — Calls recorded in history.
  - `historyErrors` integer, required — Recorded calls that ended in a gRPC error.

## Other responses

- `500` — Internal Server Error

## Changes

> 20 revisions in range; 3 could not be searched.

- **2026-07-20** `e2b32002bad4` — 5 info
  - added the optional property `coveredMethods` to the response with the `200` status
  - added the optional property `gatewayAddr` to the response with the `200` status
  - added the optional property `grpcAddr` to the response with the `200` status
  - added the optional property `httpAddr` to the response with the `200` status
  - …1 more
- **2026-03-11** `b5826549bbe8` — 1 info
  - endpoint added
- **2025-12-06** `8784e347c130` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/bavix/apis/gripmock-api-schema/changes/dashboard/get.md)

---

[API](https://skmtc.dev/bavix/apis/gripmock-api-schema.md) · [All operations](https://skmtc.dev/bavix/apis/gripmock-api-schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bavix/gripmock-api-schema/revisions/48019d318a0f/schema)