---
title: "Health Check"
method: GET
path: "/healthcheck"
tags: ["General"]
---

# Health Check

`GET /healthcheck`

## Request

- Base URL: `https://api.mediamath.com/api/v3.0`
- URL: `https://api.mediamath.com/api/v3.0/healthcheck`
- Auth: OAuth 2
  - Authorization code: `https://auth.mediamath.com/authorize`
  - Token URL: `https://auth.mediamath.com/oauth/token` scopes: `offline_access`, `manage:services`
- TypeScript: <https://skmtc.dev/mediamath/apis/campaigns-api/docs/healthcheck/get.ts> (a function with typed inputs; its response is checked against the schema)

Health endpoint to check availability

## Response `200`

Health check response

- object
  - `build_version` string
  - `build_date` string
  - `database_connection` boolean
  - `latency` string: next format is used: `5 ms` for latency more than 1ms and `5 µs` for latency less than 1ms
  - `node_conns` object
    - `acquired` integer
    - `constucting` integer
    - `idle` integer
  - `node_max_conns` integer
  - `node_total_cons` integer

## Other responses

- `400`: Error response
- `401`: Error response
- `403`: Error response
- `503`: Health check response if code is 503

---

[API](https://skmtc.dev/mediamath/apis/campaigns-api.md) - [All operations](https://skmtc.dev/mediamath/apis/campaigns-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mediamath/apis/campaigns-api/revisions/408743891def?raw)
