---
title: "Error heatmap"
method: GET
path: "/errors/heatmap"
tags: ["Errors"]
---

# Error heatmap

`GET /errors/heatmap`

## Request

- Base URL: `https://api.tatum.io/v4/logs`
- URL: `https://api.tatum.io/v4/logs/errors/heatmap`
- Auth: API key in header `x-api-key`

Returns per-network bucketed error counts for the heatmap visualization.

## Query parameters

- `time_range` union
  - '5m'
  - '15m'
  - '1h'
  - '6h'
  - '24h'
  - '7d'
  - '14d'
  - '30d'
- `from` string, date-time
- `to` string, date-time
- `search` string
- `rank_by` union
  - 'errors'
  - 'usage'
- `filter[network][in]` string[]
- `filter[network][nin]` string[]
- `filter[chain][in]` string[]
- `filter[chain][nin]` string[]
- `filter[source][in]` string[]
- `filter[source][nin]` string[]
- `filter[operation][in]` string[]
- `filter[operation][nin]` string[]
- `filter[operation][contains]` string
- `filter[error_code][in]` integer[]
- `filter[error_code][nin]` integer[]
- `filter[error_code][between]` integer[]
- `filter[req_id][in]` string[]

## Response `200`

Per-network error counts bucketed over the requested window.

- ErrorHeatmapResponse: Error heatmap: one row per network/chain, each with a bucketed series.
  - `networks` ErrorHeatmapNetworkRow[], required: Network rows, ordered by descending total.
    - `network` string, required: Blockchain network (chain-qualified).
    - `chain` string, required: Blockchain.
    - `buckets` HeatmapBucket[], required: Per-bucket error counts, oldest first, gap-filled across the window.
      - `timestamp` string, required: Start of the bucket, ISO-8601 UTC.
      - `count` number, required: Error count in the bucket.
    - `total` number, required: Total errors for this network across the window.
  - `capped` boolean, required: True when served from the raw table and capped; `networks` is then empty.

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/tatum/apis/logs-api.md) - [All operations](https://skmtc.dev/tatum/apis/logs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tatum/apis/logs-api/revisions/e47603e0f75f?raw)