Heatmap, Soft friendly 1.0.0
| Template | Heatmap, tpl_253e24d3c157 |
|---|---|
| Variant | Soft friendly |
| Version | 1.0.0, the newest: what a channel following this variant draws |
| Shapes | 9x16, 4x5, 1x1, 16x9, 2x3 |
| Length | 8 seconds |
Example video
The 1x1 cut of this version, drawn from its own worked example. Open the video on its own.
What it accepts
Changes as equal tiles or as a matrix of up to sixteen rows under up to seven column headings, every cell coloured on one scale from the brand's down colour through a neutral to its up colour and labelled with its value exactly as sent: the cells stand empty on the cover, then light up. metaData is the post's title, descriptions and hashtags and is never drawn.
| Field | Type | Required | Limit | What it is |
|---|---|---|---|---|
clipData | group | yes | Clip data: Everything drawn: a kicker, the title, the layout, the unit, what the colour shows, the column headings, the rows with their values, a note, the source and the look. | |
clipData.kicker | text | up to 20 characters | Kicker: A word above the title, such as RAINFALL, MARKETS or THIS WEEK. | |
clipData.title | text | yes | up to 80 characters | Title: What the cells show. On the cover from the first frame. |
clipData.mode | enum | matrix, tiles | Layout: Left out, a matrix where column headings or more than one value a row are sent, else tiles. | |
clipData.unit | text | up to 6 characters | Unit: Written after every value, such as %, pts or °C. Left out, a percent sign. | |
clipData.scaleLabel | text | up to 30 characters | What the colour shows: Written beside the colour key under the cells, such as Change on the day. | |
clipData.columns | list | up to 7 | Column headings: For the matrix: up to seven short headings over the columns, such as the days of a week or months. They stand from the first frame. Not drawn as tiles. | |
clipData.columns[] | text | up to 8 characters | Heading | |
clipData.rows | list | yes | at least 1, up to 16 | Rows: One to sixteen, drawn in the order sent. In the matrix each is a row of cells under the column headings; as tiles each is one tile showing its first value. Where they do not all fit the frame at a readable size, they turn pages. |
clipData.rows[] | group | Row | ||
clipData.rows[].label | text | yes | up to 18 characters | Name |
clipData.rows[].values | list | yes | at least 1, up to 7 | Values: One per column, in the same order, from -999.99 to 999.99, shown exactly as sent with a + before a rise. Above nought takes the brand's up colour, below its down colour, nought the neutral. A row with fewer values than there are columns leaves the rest of its cells empty. |
clipData.rows[].values[] | number | from -999.99, to 999.99, 2 decimals | Value | |
clipData.note | text | up to 100 characters | Note: One line under the cells, or beside them on 16x9. | |
clipData.source | text | up to 60 characters | Source: Where the figures come from. | |
clipData.look | group | Look: How the clip looks and moves within its style. The same five switches in every format of the collections. Leave a switch out, or set it to the style's own, and the style decides. | ||
clipData.look.theme | enum | auto, brand, light, dark, bold | Theme: The style's own choice; your brand's own colours and background; a light or dark page tinted with your brand colour; or your brand colour as the page. | |
clipData.look.pace | enum | auto, calm, standard, punchy | Pace: How things arrive: the style's own rhythm, calm fades, a standard rhythm, or punchy slams and cuts. | |
clipData.look.corners | enum | auto, square, soft, round | Corners: The shape of cards, panels and marks. | |
clipData.look.align | enum | auto, start, centre | Text alignment: Where the text lines up. | |
clipData.look.logo | enum | auto, free | Logo: The style's own: the logo on the style's plate (a card, a disc, a badge) so it reads on any page. As it is: the logo whole, with no plate, frame or crop, for a logo made to stand on the page, such as one with a transparent background. As it is, make sure your logo reads on the page of the theme you choose. | |
metaData | group | Meta data: Everything about the post that is never drawn in the clip: its title, its description in four lengths, one per kind of platform, and its hashtags. Reelwire adds the brand's description, link and hashtags after it. Left out, the post text is generated from the clip data. | ||
metaData.title | text | up to 100 characters | Title: Used where the platform has a title of its own: Facebook Feed, LinkedIn, Pinterest and YouTube. Up to 100 characters, which every one of them takes. | |
metaData.captionTiny | text | up to 200 characters | Tiny description (Pinterest, Threads, X): Up to 200 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.captionShort | text | up to 500 characters | Short description (Telegram, Threema, WeChat, WhatsApp): Up to 500 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.captionMedium | text | up to 1500 characters | Medium description (Discord, Facebook Reels, Instagram, LinkedIn, Signal, Slack, TikTok): Up to 1500 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.captionLong | text | up to 4000 characters | Long description (Facebook Feed, YouTube): Up to 4000 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.hashtags | list | up to 15 | Hashtags: Written without the #. Up to 15, which every platform takes. | |
metaData.hashtags[] | text | up to 60 characters | Hashtag |
locales carries other languages: under each language code, the parts of clipData and metaData that differ, laid over the default, so a language with no copy still renders.
A picture is always a file from your media library: media:// followed by its id or its name.
Anything the table does not list is refused, and so is anything over its limit, with a 400
schema_validation error that names the field.
The JSON Schema
{
"type": "object",
"properties": {
"clipData": {
"type": "object",
"properties": {
"kicker": {
"type": "string",
"maxLength": 20,
"title": "Kicker",
"description": "A word above the title, such as RAINFALL, MARKETS or THIS WEEK."
},
"title": {
"type": "string",
"maxLength": 80,
"title": "Title",
"description": "What the cells show. On the cover from the first frame."
},
"mode": {
"type": "string",
"enum": [
"matrix",
"tiles"
],
"title": "Layout",
"description": "Left out, a matrix where column headings or more than one value a row are sent, else tiles.",
"enumNames": [
"Matrix: rows of cells under column headings",
"Tiles: one tile a row, showing its first value"
]
},
"unit": {
"type": "string",
"maxLength": 6,
"title": "Unit",
"description": "Written after every value, such as %, pts or °C. Left out, a percent sign."
},
"scaleLabel": {
"type": "string",
"maxLength": 30,
"title": "What the colour shows",
"description": "Written beside the colour key under the cells, such as Change on the day."
},
"columns": {
"type": "array",
"items": {
"type": "string",
"maxLength": 8,
"title": "Heading"
},
"maxItems": 7,
"title": "Column headings",
"description": "For the matrix: up to seven short headings over the columns, such as the days of a week or months. They stand from the first frame. Not drawn as tiles."
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 18,
"title": "Name"
},
"values": {
"type": "array",
"items": {
"type": "number",
"minimum": -999.99,
"maximum": 999.99,
"title": "Value"
},
"minItems": 1,
"maxItems": 7,
"title": "Values",
"description": "One per column, in the same order, from -999.99 to 999.99, shown exactly as sent with a + before a rise. Above nought takes the brand's up colour, below its down colour, nought the neutral. A row with fewer values than there are columns leaves the rest of its cells empty."
}
},
"required": [
"label",
"values"
],
"additionalProperties": false,
"title": "Row"
},
"minItems": 1,
"maxItems": 16,
"title": "Rows",
"description": "One to sixteen, drawn in the order sent. In the matrix each is a row of cells under the column headings; as tiles each is one tile showing its first value. Where they do not all fit the frame at a readable size, they turn pages."
},
"note": {
"type": "string",
"maxLength": 100,
"title": "Note",
"description": "One line under the cells, or beside them on 16x9."
},
"source": {
"type": "string",
"maxLength": 60,
"title": "Source",
"description": "Where the figures come from."
},
"look": {
"type": "object",
"properties": {
"theme": {
"type": "string",
"enum": [
"auto",
"brand",
"light",
"dark",
"bold"
],
"title": "Theme",
"description": "The style's own choice; your brand's own colours and background; a light or dark page tinted with your brand colour; or your brand colour as the page.",
"enumNames": [
"The style's own",
"Brand colours",
"Light",
"Dark",
"Bold brand colour"
]
},
"pace": {
"type": "string",
"enum": [
"auto",
"calm",
"standard",
"punchy"
],
"title": "Pace",
"description": "How things arrive: the style's own rhythm, calm fades, a standard rhythm, or punchy slams and cuts.",
"enumNames": [
"The style's own",
"Calm",
"Standard",
"Punchy"
]
},
"corners": {
"type": "string",
"enum": [
"auto",
"square",
"soft",
"round"
],
"title": "Corners",
"description": "The shape of cards, panels and marks.",
"enumNames": [
"The style's own",
"Square",
"Softly rounded",
"Round"
]
},
"align": {
"type": "string",
"enum": [
"auto",
"start",
"centre"
],
"title": "Text alignment",
"description": "Where the text lines up.",
"enumNames": [
"The style's own",
"At the start of the line",
"Centred"
]
},
"logo": {
"type": "string",
"enum": [
"auto",
"free"
],
"title": "Logo",
"description": "The style's own: the logo on the style's plate (a card, a disc, a badge) so it reads on any page. As it is: the logo whole, with no plate, frame or crop, for a logo made to stand on the page, such as one with a transparent background. As it is, make sure your logo reads on the page of the theme you choose.",
"enumNames": [
"The style's own",
"As it is, no plate or crop"
]
}
},
"additionalProperties": false,
"title": "Look",
"description": "How the clip looks and moves within its style. The same five switches in every format of the collections. Leave a switch out, or set it to the style's own, and the style decides."
}
},
"required": [
"title",
"rows"
],
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn: a kicker, the title, the layout, the unit, what the colour shows, the column headings, the rows with their values, a note, the source and the look."
},
"metaData": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 100,
"title": "Title",
"description": "Used where the platform has a title of its own: Facebook Feed, LinkedIn, Pinterest and YouTube. Up to 100 characters, which every one of them takes."
},
"captionTiny": {
"type": "string",
"maxLength": 200,
"title": "Tiny description (Pinterest, Threads, X)",
"description": "Up to 200 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionShort": {
"type": "string",
"maxLength": 500,
"title": "Short description (Telegram, Threema, WeChat, WhatsApp)",
"description": "Up to 500 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionMedium": {
"type": "string",
"maxLength": 1500,
"title": "Medium description (Discord, Facebook Reels, Instagram, LinkedIn, Signal, Slack, TikTok)",
"description": "Up to 1500 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionLong": {
"type": "string",
"maxLength": 4000,
"title": "Long description (Facebook Feed, YouTube)",
"description": "Up to 4000 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"hashtags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"title": "Hashtag"
},
"maxItems": 15,
"title": "Hashtags",
"description": "Written without the #. Up to 15, which every platform takes."
}
},
"additionalProperties": false,
"title": "Meta data",
"description": "Everything about the post that is never drawn in the clip: its title, its description in four lengths, one per kind of platform, and its hashtags. Reelwire adds the brand's description, link and hashtags after it. Left out, the post text is generated from the clip data."
},
"locales": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clipData": {
"type": "object",
"properties": {
"kicker": {
"type": "string",
"maxLength": 20,
"title": "Kicker",
"description": "A word above the title, such as RAINFALL, MARKETS or THIS WEEK."
},
"title": {
"type": "string",
"maxLength": 80,
"title": "Title",
"description": "What the cells show. On the cover from the first frame."
},
"mode": {
"type": "string",
"enum": [
"matrix",
"tiles"
],
"title": "Layout",
"description": "Left out, a matrix where column headings or more than one value a row are sent, else tiles.",
"enumNames": [
"Matrix: rows of cells under column headings",
"Tiles: one tile a row, showing its first value"
]
},
"unit": {
"type": "string",
"maxLength": 6,
"title": "Unit",
"description": "Written after every value, such as %, pts or °C. Left out, a percent sign."
},
"scaleLabel": {
"type": "string",
"maxLength": 30,
"title": "What the colour shows",
"description": "Written beside the colour key under the cells, such as Change on the day."
},
"columns": {
"type": "array",
"items": {
"type": "string",
"maxLength": 8,
"title": "Heading"
},
"maxItems": 7,
"title": "Column headings",
"description": "For the matrix: up to seven short headings over the columns, such as the days of a week or months. They stand from the first frame. Not drawn as tiles."
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 18,
"title": "Name"
},
"values": {
"type": "array",
"items": {
"type": "number",
"minimum": -999.99,
"maximum": 999.99,
"title": "Value"
},
"minItems": 1,
"maxItems": 7,
"title": "Values",
"description": "One per column, in the same order, from -999.99 to 999.99, shown exactly as sent with a + before a rise. Above nought takes the brand's up colour, below its down colour, nought the neutral. A row with fewer values than there are columns leaves the rest of its cells empty."
}
},
"required": [
"label",
"values"
],
"additionalProperties": false,
"title": "Row"
},
"minItems": 1,
"maxItems": 16,
"title": "Rows",
"description": "One to sixteen, drawn in the order sent. In the matrix each is a row of cells under the column headings; as tiles each is one tile showing its first value. Where they do not all fit the frame at a readable size, they turn pages."
},
"note": {
"type": "string",
"maxLength": 100,
"title": "Note",
"description": "One line under the cells, or beside them on 16x9."
},
"source": {
"type": "string",
"maxLength": 60,
"title": "Source",
"description": "Where the figures come from."
},
"look": {
"type": "object",
"properties": {
"theme": {
"type": "string",
"enum": [
"auto",
"brand",
"light",
"dark",
"bold"
],
"title": "Theme",
"description": "The style's own choice; your brand's own colours and background; a light or dark page tinted with your brand colour; or your brand colour as the page.",
"enumNames": [
"The style's own",
"Brand colours",
"Light",
"Dark",
"Bold brand colour"
]
},
"pace": {
"type": "string",
"enum": [
"auto",
"calm",
"standard",
"punchy"
],
"title": "Pace",
"description": "How things arrive: the style's own rhythm, calm fades, a standard rhythm, or punchy slams and cuts.",
"enumNames": [
"The style's own",
"Calm",
"Standard",
"Punchy"
]
},
"corners": {
"type": "string",
"enum": [
"auto",
"square",
"soft",
"round"
],
"title": "Corners",
"description": "The shape of cards, panels and marks.",
"enumNames": [
"The style's own",
"Square",
"Softly rounded",
"Round"
]
},
"align": {
"type": "string",
"enum": [
"auto",
"start",
"centre"
],
"title": "Text alignment",
"description": "Where the text lines up.",
"enumNames": [
"The style's own",
"At the start of the line",
"Centred"
]
},
"logo": {
"type": "string",
"enum": [
"auto",
"free"
],
"title": "Logo",
"description": "The style's own: the logo on the style's plate (a card, a disc, a badge) so it reads on any page. As it is: the logo whole, with no plate, frame or crop, for a logo made to stand on the page, such as one with a transparent background. As it is, make sure your logo reads on the page of the theme you choose.",
"enumNames": [
"The style's own",
"As it is, no plate or crop"
]
}
},
"additionalProperties": false,
"title": "Look",
"description": "How the clip looks and moves within its style. The same five switches in every format of the collections. Leave a switch out, or set it to the style's own, and the style decides."
}
},
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn: a kicker, the title, the layout, the unit, what the colour shows, the column headings, the rows with their values, a note, the source and the look."
},
"metaData": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 100,
"title": "Title",
"description": "Used where the platform has a title of its own: Facebook Feed, LinkedIn, Pinterest and YouTube. Up to 100 characters, which every one of them takes."
},
"captionTiny": {
"type": "string",
"maxLength": 200,
"title": "Tiny description (Pinterest, Threads, X)",
"description": "Up to 200 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionShort": {
"type": "string",
"maxLength": 500,
"title": "Short description (Telegram, Threema, WeChat, WhatsApp)",
"description": "Up to 500 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionMedium": {
"type": "string",
"maxLength": 1500,
"title": "Medium description (Discord, Facebook Reels, Instagram, LinkedIn, Signal, Slack, TikTok)",
"description": "Up to 1500 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionLong": {
"type": "string",
"maxLength": 4000,
"title": "Long description (Facebook Feed, YouTube)",
"description": "Up to 4000 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"hashtags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"title": "Hashtag"
},
"maxItems": 15,
"title": "Hashtags",
"description": "Written without the #. Up to 15, which every platform takes."
}
},
"additionalProperties": false,
"title": "Meta data",
"description": "Everything about the post that is never drawn in the clip: its title, its description in four lengths, one per kind of platform, and its hashtags. Reelwire adds the brand's description, link and hashtags after it. Left out, the post text is generated from the clip data."
}
},
"additionalProperties": false
},
"propertyNames": {
"enum": [
"aa",
"ab",
"ae",
"af",
"ak",
"am",
"an",
"ar",
"as",
"av",
"ay",
"az",
"ba",
"be",
"bg",
"bi",
"bm",
"bn",
"bo",
"br",
"bs",
"ca",
"ce",
"ch",
"co",
"cr",
"cs",
"cu",
"cv",
"cy",
"da",
"de",
"dv",
"dz",
"ee",
"el",
"en",
"eo",
"es",
"et",
"eu",
"fa",
"ff",
"fi",
"fj",
"fo",
"fr",
"fy",
"ga",
"gd",
"gl",
"gn",
"gu",
"gv",
"ha",
"he",
"hi",
"ho",
"hr",
"ht",
"hu",
"hy",
"hz",
"ia",
"id",
"ie",
"ig",
"ii",
"ik",
"io",
"is",
"it",
"iu",
"ja",
"jv",
"ka",
"kg",
"ki",
"kj",
"kk",
"kl",
"km",
"kn",
"ko",
"kr",
"ks",
"ku",
"kv",
"kw",
"ky",
"la",
"lb",
"lg",
"li",
"ln",
"lo",
"lt",
"lu",
"lv",
"mg",
"mh",
"mi",
"mk",
"ml",
"mn",
"mr",
"ms",
"mt",
"my",
"na",
"nb",
"nd",
"ne",
"ng",
"nl",
"nn",
"no",
"nr",
"nv",
"ny",
"oc",
"oj",
"om",
"or",
"os",
"pa",
"pi",
"pl",
"ps",
"pt",
"qu",
"rm",
"rn",
"ro",
"ru",
"rw",
"sa",
"sc",
"sd",
"se",
"sg",
"si",
"sk",
"sl",
"sm",
"sn",
"so",
"sq",
"sr",
"ss",
"st",
"su",
"sv",
"sw",
"ta",
"te",
"tg",
"th",
"ti",
"tk",
"tl",
"tn",
"to",
"tr",
"ts",
"tt",
"tw",
"ty",
"ug",
"uk",
"ur",
"uz",
"ve",
"vi",
"vo",
"wa",
"wo",
"xh",
"yi",
"yo",
"za",
"zh",
"zu",
"zh-CN",
"zh-TW",
"pt-BR"
]
}
}
},
"required": [
"clipData"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}
Ask Reelwire for the same document yourself, without signing in:
curl "http://localhost:4000/v1/formats/template/tpl_253e24d3c157?variant=Soft%20friendly&version=1.0.0"
Delivery JSON
Your own system sends this to one of your streams, POST /v1/stream, and every channel listening to
that stream draws it with its template. data is the document described above; a stream with an
empty field map passes it to the template unchanged. Try it first on POST /v1/stream/validate,
which answers the same without publishing anything. Streams and feeds
explains the rest, including how to map a document of your own shape instead.
{
"streamId": "st_your_stream_id",
"eventId": "01M2SQMKK3G1NVFXV31DCBVB95",
"occurredAt": "2026-09-23T07:00:00Z",
"locale": "en",
"data": {
"clipData": {
"kicker": "Rainfall",
"title": "Rain against the long-term average, region by region, from April to September",
"mode": "matrix",
"unit": "%",
"scaleLabel": "Rain against the average",
"columns": [
"Apr",
"May",
"Jun",
"Jul",
"Aug",
"Sep"
],
"rows": [
{
"label": "Northern uplands",
"values": [
18,
34,
-6,
12,
41,
22
]
},
{
"label": "East coast",
"values": [
-8,
4,
-22,
-15,
9,
-3
]
},
{
"label": "Central valley",
"values": [
-12,
-18,
-41,
-36,
-9,
6
]
},
{
"label": "South",
"values": [
-20,
-31,
-58,
-47,
-26,
-10
]
},
{
"label": "West",
"values": [
6,
12,
-14,
3,
28,
15
]
},
{
"label": "Islands",
"values": [
25,
9,
0,
16,
52,
30
]
}
],
"note": "The south had under half its usual rain in July, the islands half as much again in August.",
"source": "National weather service, monthly climate summaries",
"look": {
"theme": "auto",
"pace": "auto",
"corners": "auto",
"align": "auto",
"logo": "auto"
}
},
"metaData": {
"title": "Six regions, six months: where the summer was wet and where it was dry",
"captionTiny": "Six regions, six months, one colour scale. The south had under half its usual rain in July, while the islands had half as much again in August.",
"captionShort": "Rain against the long-term average, region by region, from April to September. Every cell is one month in one region: one colour for wetter than usual, the other for drier, and the deeper the colour the bigger the difference. The south was the driest all summer, with 58 percent less rain than usual in July. The islands and the northern uplands were the wettest, the islands with 52 percent more in August.",
"captionMedium": "Rain against the long-term average, region by region, from April to September. Every cell is one month in one region: one colour for wetter than usual, the other for drier, and the deeper the colour the bigger the difference.\n\nThe south was the driest region in every month, with 58 percent less rain than usual in July and 47 percent less in August. The central valley followed it, dry from May to August.\n\nThe islands and the northern uplands were the wettest. The islands had 52 percent more rain than usual in August and the uplands 41 percent more.\n\nBy September most regions were closer to the average again.",
"captionLong": "Rain against the long-term average, region by region, from April to September. Every cell is one month in one region: one colour for wetter than usual, the other for drier, and the deeper the colour the bigger the difference. A grid like this shows in one picture what a table of thirty-six numbers hides: which months were dry, and where.\n\nThe south was the driest region in every month of the summer. It had 58 percent less rain than usual in July and 47 percent less in August, and even September stayed 10 percent below the average. The central valley followed it, dry from May to August, with 41 percent less rain in June.\n\nThe islands and the northern uplands were the wettest. The islands had 52 percent more rain than usual in August and 30 percent more in September; the uplands had 41 percent more in August.\n\nThe east coast and the west stayed closest to the average, never more than 28 percent either way.\n\nBy September most regions were closer to the average again. The figures compare each month's rain with the average for that month from 1991 to 2020.",
"hashtags": [
"rainfall",
"weather",
"climate",
"summer",
"heatmap",
"dataviz"
]
}
}
}
The delivery names no version: which build draws it is the channel's choice, the newest of its
variant or the one it is pinned to. eventId is a ULID you make once per event: sending the same
one again changes nothing. occurredAt is when the thing happened, not when you sent it. locale
is the language of the text in data, and data.locales carries other languages beside it.