Treemap, Data terminal 1.0.0
| Template | Treemap, tpl_c0d65666b5b0 |
|---|---|
| Variant | Data terminal |
| Version | 1.0.0, the newest: what a channel following this variant draws |
| Shapes | 9x16, 4x5, 1x1, 16x9, 2x3 |
| Length | 10 seconds |
Example video
The 1x1 cut of this version, drawn from its own worked example. Open the video on its own.
What it accepts
Two to twelve parts of one whole as rectangles, each exactly as large as its value, coloured by its change from the brand's fall colour through a neutral to its rise colour and labelled with as much as fits: the rectangles grow into place largest first. 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, how the values are written, what the size and the colour stand for, the parts with their value and change, the source and the look. | |
clipData.kicker | text | up to 20 characters | Kicker: A word or two above the title, such as BUDGET or MARKETS. | |
clipData.title | text | yes | up to 80 characters | Title: What the whole is and what the colours show. |
clipData.prefix | text | up to 3 characters | Prefix: Written before every value, such as a currency sign. | |
clipData.unit | text | up to 12 characters | Unit: Written after every value: m, bn, TWh, people. | |
clipData.sizeLabel | text | up to 30 characters | What the size shows: Written in the key under the rectangles, beside a small drawn treemap. | |
clipData.changeLabel | text | up to 30 characters | What the colour shows: Written in the key beside the colour scale, which runs from the lowest change sent to the highest. | |
clipData.changeUnit | text | up to 6 characters | Unit of the change: Written after every change. Left out, a percent sign. | |
clipData.items | list | yes | at least 2, up to 12 | Parts: Two to twelve parts of one whole. Drawn largest first, whatever order they are sent in, each rectangle exactly as large as its value. A part of nought is left out. The clip runs 8 to 11 seconds with the parts. |
clipData.items[] | group | Part | ||
clipData.items[].label | text | yes | up to 24 characters | Name |
clipData.items[].short | text | up to 8 characters | Short name: Shown where the full name does not fit, such as a ticker or an abbreviation. | |
clipData.items[].value | number | yes | from 0, 4 decimals | Value: Sets the size of the rectangle. |
clipData.items[].change | number | 4 decimals | Change: Sets the colour: the brand's rise colour for up, its fall colour for down, a neutral grey for no change, stronger the larger the move. Left out on every part, the rectangles are the brand colour and the key shows no scale. | |
clipData.source | text | up to 60 characters | Source | |
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 or two above the title, such as BUDGET or MARKETS."
},
"title": {
"type": "string",
"maxLength": 80,
"title": "Title",
"description": "What the whole is and what the colours show."
},
"prefix": {
"type": "string",
"maxLength": 3,
"title": "Prefix",
"description": "Written before every value, such as a currency sign."
},
"unit": {
"type": "string",
"maxLength": 12,
"title": "Unit",
"description": "Written after every value: m, bn, TWh, people."
},
"sizeLabel": {
"type": "string",
"maxLength": 30,
"title": "What the size shows",
"description": "Written in the key under the rectangles, beside a small drawn treemap."
},
"changeLabel": {
"type": "string",
"maxLength": 30,
"title": "What the colour shows",
"description": "Written in the key beside the colour scale, which runs from the lowest change sent to the highest."
},
"changeUnit": {
"type": "string",
"maxLength": 6,
"title": "Unit of the change",
"description": "Written after every change. Left out, a percent sign."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 24,
"title": "Name"
},
"short": {
"type": "string",
"maxLength": 8,
"title": "Short name",
"description": "Shown where the full name does not fit, such as a ticker or an abbreviation."
},
"value": {
"type": "number",
"minimum": 0,
"title": "Value",
"description": "Sets the size of the rectangle."
},
"change": {
"type": "number",
"title": "Change",
"description": "Sets the colour: the brand's rise colour for up, its fall colour for down, a neutral grey for no change, stronger the larger the move. Left out on every part, the rectangles are the brand colour and the key shows no scale."
}
},
"required": [
"label",
"value"
],
"additionalProperties": false,
"title": "Part"
},
"minItems": 2,
"maxItems": 12,
"title": "Parts",
"description": "Two to twelve parts of one whole. Drawn largest first, whatever order they are sent in, each rectangle exactly as large as its value. A part of nought is left out. The clip runs 8 to 11 seconds with the parts."
},
"source": {
"type": "string",
"maxLength": 60,
"title": "Source"
},
"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",
"items"
],
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn: a kicker, the title, how the values are written, what the size and the colour stand for, the parts with their value and change, 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 or two above the title, such as BUDGET or MARKETS."
},
"title": {
"type": "string",
"maxLength": 80,
"title": "Title",
"description": "What the whole is and what the colours show."
},
"prefix": {
"type": "string",
"maxLength": 3,
"title": "Prefix",
"description": "Written before every value, such as a currency sign."
},
"unit": {
"type": "string",
"maxLength": 12,
"title": "Unit",
"description": "Written after every value: m, bn, TWh, people."
},
"sizeLabel": {
"type": "string",
"maxLength": 30,
"title": "What the size shows",
"description": "Written in the key under the rectangles, beside a small drawn treemap."
},
"changeLabel": {
"type": "string",
"maxLength": 30,
"title": "What the colour shows",
"description": "Written in the key beside the colour scale, which runs from the lowest change sent to the highest."
},
"changeUnit": {
"type": "string",
"maxLength": 6,
"title": "Unit of the change",
"description": "Written after every change. Left out, a percent sign."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 24,
"title": "Name"
},
"short": {
"type": "string",
"maxLength": 8,
"title": "Short name",
"description": "Shown where the full name does not fit, such as a ticker or an abbreviation."
},
"value": {
"type": "number",
"minimum": 0,
"title": "Value",
"description": "Sets the size of the rectangle."
},
"change": {
"type": "number",
"title": "Change",
"description": "Sets the colour: the brand's rise colour for up, its fall colour for down, a neutral grey for no change, stronger the larger the move. Left out on every part, the rectangles are the brand colour and the key shows no scale."
}
},
"required": [
"label",
"value"
],
"additionalProperties": false,
"title": "Part"
},
"minItems": 2,
"maxItems": 12,
"title": "Parts",
"description": "Two to twelve parts of one whole. Drawn largest first, whatever order they are sent in, each rectangle exactly as large as its value. A part of nought is left out. The clip runs 8 to 11 seconds with the parts."
},
"source": {
"type": "string",
"maxLength": 60,
"title": "Source"
},
"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, how the values are written, what the size and the colour stand for, the parts with their value and change, 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_c0d65666b5b0?variant=Data%20terminal&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": "Budget 2027",
"title": "Where the city's 2027 budget goes, and how each part changed on last year",
"prefix": "€",
"unit": "m",
"sizeLabel": "Budget, million euros",
"changeLabel": "Change on 2026",
"changeUnit": "%",
"items": [
{
"label": "Social care and housing",
"short": "Care",
"value": 412,
"change": 4.8
},
{
"label": "Schools and childcare",
"short": "Schools",
"value": 298,
"change": 2.1
},
{
"label": "Public transport",
"short": "Transit",
"value": 187,
"change": 6.5
},
{
"label": "Roads and bridges",
"short": "Roads",
"value": 143,
"change": -3.2
},
{
"label": "Fire and rescue",
"short": "Fire",
"value": 121,
"change": 1.2
},
{
"label": "Waste and recycling",
"short": "Waste",
"value": 96,
"change": 0.4
},
{
"label": "Parks and sport",
"short": "Parks",
"value": 84,
"change": -1.7
},
{
"label": "Administration",
"short": "Admin",
"value": 61,
"change": -2.4
},
{
"label": "Libraries and culture",
"short": "Culture",
"value": 47,
"change": -4
},
{
"label": "Planning",
"short": "Plan",
"value": 38,
"change": 0
}
],
"source": "City council, budget for 2027 as adopted",
"look": {
"theme": "auto",
"pace": "auto",
"corners": "auto",
"align": "auto",
"logo": "auto"
}
},
"metaData": {
"title": "Where the city's 2027 budget goes, and which parts grew or shrank on last year",
"captionTiny": "The city's 2027 budget, each service as large as its share and coloured by how it changed on last year. Public transport grew most, libraries and culture fell most.",
"captionShort": "Where the city's 1.49 billion euro budget for 2027 goes, each service drawn as large as its budget and coloured by how it changed on last year. Social care and housing is still the largest part at 412 million euros, up 4.8 percent. Public transport grew most, by 6.5 percent, while libraries and culture fell 4 percent and roads and bridges 3.2 percent.",
"captionMedium": "Where the city's 1.49 billion euro budget for 2027 goes, each service drawn as large as its budget and coloured by how it changed on last year.\n\nSocial care and housing is still by far the largest part at 412 million euros, up 4.8 percent, followed by schools and childcare at 298 million, up 2.1 percent. Public transport grew most of all, by 6.5 percent to 187 million euros.\n\nFour services were cut: libraries and culture by 4 percent, roads and bridges by 3.2 percent, administration by 2.4 percent and parks and sport by 1.7 percent. Planning stayed exactly where it was. The figures are from the budget the council adopted.",
"captionLong": "Where the city's 1.49 billion euro budget for 2027 goes, each service drawn as large as its budget and coloured by how it changed on last year. A treemap shows two things at once: how large each part of the budget is next to the others, and which way it moved.\n\nSocial care and housing is still by far the largest part at 412 million euros, up 4.8 percent, and with schools and childcare at 298 million it takes almost half of the whole budget. Public transport grew most of all, by 6.5 percent to 187 million euros. Fire and rescue rose 1.2 percent and waste and recycling 0.4 percent.\n\nFour services were cut: libraries and culture by 4 percent to 47 million euros, roads and bridges by 3.2 percent, administration by 2.4 percent and parks and sport by 1.7 percent. Planning stayed exactly where it was, at 38 million euros.\n\nThe figures are from the budget the council adopted for 2027; each change compares a service with its budget for 2026.",
"hashtags": [
"budget",
"citycouncil",
"publicspending",
"treemap",
"localgovernment"
]
}
}
}
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.