---
title: "GET /api/v1/metrics/checks/schema/"
method: GET
path: "/api/v1/metrics/checks/schema/"
tags: ["metrics"]
---

# GET /api/v1/metrics/checks/schema/

`GET /api/v1/metrics/checks/schema/`

## Request

- Base URL: `https://uptime.com` (the document declares no server; this is the origin it was published from)
- URL: `https://uptime.com/api/v1/metrics/checks/schema/`
- Auth: none declared
- TypeScript: <https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/docs/api/v1/metrics/checks/schema/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the schema-driven catalog organized by check type.

Use this once at startup (and cache) to discover what data types and
metrics are available per check type.

## Query parameters

- `check_type` string
- `check_id` integer

## Response `200`

- MetricsSchema
  - `check_type` string: Filter to a single check type (e.g. ``HTTP``, ``TRANSACTION``, ``SSL_CERT``).
  - `check_id` integer: Filter to the check type of this check. Convenience shorthand — the API resolves the check's type and returns that entry.

---

[API](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema.md) - [All operations](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/llms.txt) - [OpenAPI document](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/revisions/e1e4a57a60d8?raw)