▣ IMAGE PROCESSING · SMART GENERATION

Generate HeatMap Chart API

Hosted on ApyHub

What it does

Heatmap Chart Generator turns dated numeric data into a calendar heatmap chart and returns either an image file or a pre-signed image URL.

Send Heatmap Chart Generator a title and a data array. Each data point must include a date in YYYY-MM-DD format and a numeric value. You can also pass an options object to tune the chart colors with color_low, color_med, color_high, color_empty, and color_med_low, each as a 6-character hex value without the #.

Use it when you need to visualise activity over time: daily sign-ins, commits, orders, support tickets, or any other date-based metric that is easier to read as a calendar grid than as a table. The /download endpoint generates the chart image, while /link returns a data field containing a URI to the generated chart image.

Keep the input small and explicit: a title, at least one dated value, and optional color settings. The response stays focused on the generated chart output, so it fits cleanly into reporting flows, dashboards, and internal analytics tools.

▣ ENDPOINT 01 / 02

POST

Generate calendar heatmap chart image

http://localhost:8080/apyhub/generate-simple-heatmap-chart/download

QUICKSTARTGUIDE

Quickstart

Generate and download a simple heatmap chart image from a small date/value dataset.

curl -X POST "http://localhost:8080/apyhub/generate-simple-heatmap-chart/download?output=daily-user-activity-heatmap-chart" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Daily User Activity",
    "data": [
      { "date": "2026-06-01", "value": 3 },
      { "date": "2026-06-02", "value": 7 },
      { "date": "2026-06-03", "value": 12 }
    ]
  }'

What you'll get back

Returns a binary file response which you can save directly to disk.

TRY ITLIVE · 60 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Generates a calendar heatmap chart image from the supplied data and title, then returns the generated image as a binary response.

Request Body

Parameter	Type	Mandatory	Description
data	Object Array	Yes	Array of `{ date, value }` objects used to build the chart. Each item must include the date and numeric value.
data[].date	String	Yes	Date in `YYYY-MM-DD` format.
data[].value	Number	Yes	Value for the given date.
title	String	Yes	Chart title. Must be at least 1 character long.
options	Object	No	Optional chart color settings. See schema for nested fields.
options.color_low	String	No	6-character hex color without the leading `#` symbol.
options.color_med	String	No	6-character hex color without the leading `#` symbol.
options.color_high	String	No	6-character hex color without the leading `#` symbol.
options.color_empty	String	No	6-character hex color without the leading `#` symbol.
options.color_med_low	String	No	6-character hex color without the leading `#` symbol.

Response

Returns a binary response containing the generated chart image.

Query parameters

Name

Type

Description

outputOPTIONAL

string

—

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 02 / 02

POST

Generate calendar heatmap chart link

http://localhost:8080/apyhub/generate-simple-heatmap-chart/link

QUICKSTARTGUIDE

Quickstart

Generate a simple heatmap chart from a title and date/value data points.

curl -X POST "http://localhost:8080/apyhub/generate-simple-heatmap-chart/link?output=daily-user-activity-heatmap-chart" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Daily User Activity","data":[{"date":"2026-06-01","value":3},{"date":"2026-06-02","value":7},{"date":"2026-06-03","value":12}]}'

What you'll get back

Returns a JSON object with a data string field containing a pre-signed URI for the generated chart image.

{
  "data": "https://apyhub-outgoing.s3.eu-west-1.amazonaws.com/mono-go/chart_generator/general/chart_generator_2026-08-07_a84eb504.svg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIARJOHWS6LWTUUGYPI%2F20260807%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20260807T131605Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&response-content-disposition=inline&response-content-type=image%2Fsvg%2Bxml&X-Amz-Signature=ab454ac962c26ecaebaffca14110374ee658808bcd7de47371ed84aa374ca70b"
}

TRY ITLIVE · 60 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Generates a calendar heatmap chart link from the provided title, dated data points, and optional color settings. The response returns a JSON object containing a pre-signed URL for the generated chart image.

Request Body

Parameter	Type	Mandatory	Description
title	String	Yes	Chart title.
data	Object Array	Yes	Array of data points for the heatmap. Each item must include `date` and `value`.
data[].date	String	Yes	Date in `YYYY-MM-DD` format.
data[].value	Number	Yes	Numeric value for the corresponding date.
options	Object	No	Optional color configuration. See the schema for nested fields.
options.color_low	String	No	6-character hex color without the leading `#` symbol. Pattern: `^[A-Fa-f0-9]{6}$`.
options.color_med	String	No	6-character hex color without the leading `#` symbol. Pattern: `^[A-Fa-f0-9]{6}$`.
options.color_high	String	No	6-character hex color without the leading `#` symbol. Pattern: `^[A-Fa-f0-9]{6}$`.
options.color_empty	String	No	6-character hex color without the leading `#` symbol. Pattern: `^[A-Fa-f0-9]{6}$`.
options.color_med_low	String	No	6-character hex color without the leading `#` symbol. Pattern: `^[A-Fa-f0-9]{6}$`.

Response

Returns a JSON object with a data string field formatted as a URI. This data field contains the pre-signed URL for the generated chart image.

Parameter	Type	Mandatory	Description
data	String	Yes	Pre-signed URL for the generated chart image.

Query parameters

Name

Type

Description

outputOPTIONAL

string

—

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.