---
title: "Get day × hour heatmap"
method: GET
path: "/v1/messaging/analytics/inbox/heatmap"
tags: ["Inbox Analytics"]
---

# Get day × hour heatmap

`GET /v1/messaging/analytics/inbox/heatmap`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/analytics/inbox/heatmap`
- Auth: HTTP bearer

Day-of-week × hour-of-day breakdown of inbox messages. Buckets are
sparse: only cells with at least one event are returned; clients
zero-fill the rest to render the full 7×24 grid. The `dow` field
follows ClickHouse's `toDayOfWeek` convention (1 = Monday … 7 =
Sunday). Max date range is 365 days.


**Billing:** Read (free unless it says otherwise) · **Rate limit:** 120/min

## Query parameters

- `action` 'message.received' | 'message.sent' | 'message.read' | 'all': Narrow to a single event type. "all" or omitted means no filter.
- `source` string
- `toDate` string, date
- `fromDate` string, date, required
- `platform` string
- `accountId` string

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds`
    - `to` string, date, nullable
    - `from` string, date
    - `buckets` object[]
      - `dow` integer: 1 = Monday, 7 = Sunday
      - `hour` integer
      - `read` integer
      - `sent` integer
      - `received` integer
    - `success` boolean
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)