Bar race, Data terminal 1.0.0
| Template | Bar race, tpl_88bc4a3cf966 |
|---|---|
| Variant | Data terminal |
| Version | 1.0.0, the newest: what a channel following this variant draws |
| Shapes | 9x16, 4x5, 1x1, 16x9, 2x3 |
| Length | 18 seconds |
Example video
The 1x1 cut of this version, drawn from its own worked example. Open the video on its own.
What it accepts
Up to twelve things ranked through two to twelve periods: bars that grow, shrink and overtake each other from period to period while a period counter turns, each period landing on exactly the values sent. 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 prefix and unit of every value, the periods, the racers with a value for every period, how many stand at once, a line of context, the source and the look. | |
clipData.kicker | text | up to 20 characters | Kicker: A word above the title, such as TEN YEARS or THE RACE. | |
clipData.title | text | yes | up to 80 characters | Title: What is ranked, by what and over which periods. |
clipData.prefix | text | up to 3 characters | Prefix: Written before every value, such as a currency sign. | |
clipData.unit | text | up to 8 characters | Unit: Written after every value: a percent sign, bn, t, people. | |
clipData.periods | list | yes | at least 2, up to 12 | Periods: The periods in order, oldest first: years, quarters, months. Two to twelve; each adds a second and a half to the clip. |
clipData.periods[] | text | up to 10 characters | Period | |
clipData.entities | list | yes | at least 2, up to 12 | Racers: What races: each with a value for every period, in the same order. Two to twelve; the leaders of each period stand as bars. |
clipData.entities[] | group | Racer | ||
clipData.entities[].name | text | yes | up to 24 characters | Name |
clipData.entities[].values | list | yes | at least 2, up to 12 | Values: One per period, in the same order as the periods. A period left out at the end counts as nought. |
clipData.entities[].values[] | number | from 0, 4 decimals | Value | |
clipData.entities[].highlight | boolean | Mark this racer: Drawn in the brand colour, the others a step quieter, so it can be followed through the race. Only the first marked racer is. | ||
clipData.show | integer | from 3, to 10 | Bars shown: How many of the leaders stand as bars at once, three to ten. Where a frame cannot hold them all at a readable size, it shows as many as it can. | |
clipData.note | text | up to 100 characters | Context: One line shown once the race has reached the last period. | |
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 above the title, such as TEN YEARS or THE RACE."
},
"title": {
"type": "string",
"maxLength": 80,
"title": "Title",
"description": "What is ranked, by what and over which periods."
},
"prefix": {
"type": "string",
"maxLength": 3,
"title": "Prefix",
"description": "Written before every value, such as a currency sign."
},
"unit": {
"type": "string",
"maxLength": 8,
"title": "Unit",
"description": "Written after every value: a percent sign, bn, t, people."
},
"periods": {
"type": "array",
"items": {
"type": "string",
"maxLength": 10,
"title": "Period"
},
"minItems": 2,
"maxItems": 12,
"title": "Periods",
"description": "The periods in order, oldest first: years, quarters, months. Two to twelve; each adds a second and a half to the clip."
},
"entities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 24,
"title": "Name"
},
"values": {
"type": "array",
"items": {
"type": "number",
"minimum": 0,
"title": "Value"
},
"minItems": 2,
"maxItems": 12,
"title": "Values",
"description": "One per period, in the same order as the periods. A period left out at the end counts as nought."
},
"highlight": {
"type": "boolean",
"title": "Mark this racer",
"description": "Drawn in the brand colour, the others a step quieter, so it can be followed through the race. Only the first marked racer is."
}
},
"required": [
"name",
"values"
],
"additionalProperties": false,
"title": "Racer"
},
"minItems": 2,
"maxItems": 12,
"title": "Racers",
"description": "What races: each with a value for every period, in the same order. Two to twelve; the leaders of each period stand as bars."
},
"show": {
"type": "integer",
"minimum": 3,
"maximum": 10,
"title": "Bars shown",
"description": "How many of the leaders stand as bars at once, three to ten. Where a frame cannot hold them all at a readable size, it shows as many as it can."
},
"note": {
"type": "string",
"maxLength": 100,
"title": "Context",
"description": "One line shown once the race has reached the last period."
},
"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",
"periods",
"entities"
],
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn: a kicker, the title, the prefix and unit of every value, the periods, the racers with a value for every period, how many stand at once, a line of context, 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 TEN YEARS or THE RACE."
},
"title": {
"type": "string",
"maxLength": 80,
"title": "Title",
"description": "What is ranked, by what and over which periods."
},
"prefix": {
"type": "string",
"maxLength": 3,
"title": "Prefix",
"description": "Written before every value, such as a currency sign."
},
"unit": {
"type": "string",
"maxLength": 8,
"title": "Unit",
"description": "Written after every value: a percent sign, bn, t, people."
},
"periods": {
"type": "array",
"items": {
"type": "string",
"maxLength": 10,
"title": "Period"
},
"minItems": 2,
"maxItems": 12,
"title": "Periods",
"description": "The periods in order, oldest first: years, quarters, months. Two to twelve; each adds a second and a half to the clip."
},
"entities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 24,
"title": "Name"
},
"values": {
"type": "array",
"items": {
"type": "number",
"minimum": 0,
"title": "Value"
},
"minItems": 2,
"maxItems": 12,
"title": "Values",
"description": "One per period, in the same order as the periods. A period left out at the end counts as nought."
},
"highlight": {
"type": "boolean",
"title": "Mark this racer",
"description": "Drawn in the brand colour, the others a step quieter, so it can be followed through the race. Only the first marked racer is."
}
},
"required": [
"name",
"values"
],
"additionalProperties": false,
"title": "Racer"
},
"minItems": 2,
"maxItems": 12,
"title": "Racers",
"description": "What races: each with a value for every period, in the same order. Two to twelve; the leaders of each period stand as bars."
},
"show": {
"type": "integer",
"minimum": 3,
"maximum": 10,
"title": "Bars shown",
"description": "How many of the leaders stand as bars at once, three to ten. Where a frame cannot hold them all at a readable size, it shows as many as it can."
},
"note": {
"type": "string",
"maxLength": 100,
"title": "Context",
"description": "One line shown once the race has reached the last period."
},
"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, the prefix and unit of every value, the periods, the racers with a value for every period, how many stand at once, a line of context, 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_88bc4a3cf966?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": "Ten years",
"title": "The most valuable companies on the Northwind exchange, year by year",
"prefix": "$",
"unit": "bn",
"periods": [
"2016",
"2017",
"2018",
"2019",
"2020",
"2021",
"2022",
"2023",
"2024",
"2025"
],
"entities": [
{
"name": "Meridian Bank Group",
"values": [
180,
195,
210,
220,
200,
240,
260,
300,
360,
412.6
]
},
{
"name": "Halden Works",
"values": [
55,
58,
62,
70,
95,
120,
150,
190,
240,
298.4
],
"highlight": true
},
{
"name": "Serrena Group",
"values": [
150,
170,
190,
210,
230,
250,
240,
260,
280,
288.1
]
},
{
"name": "Corvane Energy",
"values": [
260,
275,
290,
240,
150,
210,
300,
250,
230,
214.9
]
},
{
"name": "Talvik Telecom",
"values": [
200,
205,
198,
190,
185,
180,
175,
172,
170,
176.3
]
},
{
"name": "Northwind Rail & Freight",
"values": [
90,
95,
100,
105,
80,
100,
115,
130,
140,
149.8
]
},
{
"name": "Lunetta Pharma",
"values": [
60,
65,
70,
80,
140,
130,
120,
125,
128,
131.2
]
},
{
"name": "Brightwater Utilities",
"values": [
140,
145,
150,
155,
160,
150,
130,
115,
100,
97.5
]
},
{
"name": "Oskar Retail",
"values": [
120,
118,
110,
100,
120,
115,
105,
95,
90,
84
]
},
{
"name": "Fennick Logistics",
"values": [
50,
55,
60,
62,
70,
75,
66,
64,
63,
61.7
]
}
],
"show": 8,
"note": "Halden Works climbed from ninth to second in ten years",
"source": "Market value at each year's end",
"look": {
"theme": "auto",
"pace": "auto",
"corners": "auto",
"align": "auto",
"logo": "auto"
}
},
"metaData": {
"title": "Ten years of the Northwind exchange: Halden Works climbs from ninth to second",
"captionTiny": "Halden Works climbed from ninth to second on the Northwind exchange in ten years. Watch the ten most valuable companies race from 2016 to 2025.",
"captionShort": "Halden Works was worth 55 billion dollars in 2016. Ten years later it is worth 298.4 billion and the second most valuable company on the Northwind exchange. Corvane Energy led until 2019, Meridian Bank Group has led since 2023. Watch the ten largest companies race through the decade.",
"captionMedium": "Halden Works was worth 55 billion dollars in 2016 and ranked ninth on the Northwind exchange. Ten years later it is worth 298.4 billion and second only to Meridian Bank Group. Corvane Energy led the exchange until 2019, fell to fifth in 2020 and came back to the top in 2022, before Meridian Bank Group took over for good in 2023. Lunetta Pharma jumped in 2020 and has held its gains since. Watch the ten largest companies race through the decade, by market value at each year's end.",
"captionLong": "Halden Works was worth 55 billion dollars in 2016 and ranked ninth on the Northwind exchange. Ten years later it is worth 298.4 billion and second only to Meridian Bank Group. Corvane Energy led the exchange until 2019, fell to fifth in 2020 and came back to the top in 2022, before Meridian Bank Group took over for good in 2023. Lunetta Pharma jumped in 2020 and has held its gains since, while Talvik Telecom and Brightwater Utilities slowly slipped down the table. Watch the ten largest companies race through the decade, by market value at each year's end. Figures are illustrative.",
"hashtags": [
"markets",
"stocks",
"barchartrace"
]
}
}
}
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.