Map regions
Create a CHOROPLETH map — a real-world map where whole geographic AREAS (countries, states, provinces, continents, world regions) are FILLED with color to encode a value or category.
Send "type": "map_regions".
Create a CHOROPLETH map — a real-world map where whole geographic AREAS (countries, states, provinces, continents, world regions) are FILLED with color to encode a value or category.
Also available as the MCP tool render_mapregions. The same payload works through either surface.
Fields
titlestringShort descriptive title (e.g. "Population by Country", "US States by Time Zone")
levelenum<string>The single geographic level used for every region. "state" has boundary coverage only for USA, India, China, Brazil, Russia, Canada, Australia, Indonesia, South Africa — prefer "country" for other nations. One of continent, region, country or state.
colorModeenum<string>"gradient" for a value scale (use paletteColor + value), "categorical" for discrete groups (use per-region color). One of categorical or gradient.
paletteColorstringFor gradient/value maps only: a named color scheme (Blues, Greens, Reds, Oranges, Purples, Greys, YlOrRd, YlGnBu, Viridis, RdBu) or a hex color. Omit for categorical maps.
regionsobject[]requiredArray of region objects to color
Child attributes
namestringrequiredRegion's common English name
isostringISO code — alpha-3 for country level, ISO 3166-2 for state level; omit for continent/region levels
colorstringHex fill color "#RRGGBB" (categorical maps)
valuenumberUnderlying metric (gradient maps)
categorystringDiscrete group label (categorical maps)
descriptionstringOptional short note (<= 80 chars)
legendobject[]Key explaining the colors
Child attributes
labelstringcolorstringHex "#RRGGBB"
Example
{
"type": "map_regions",
"data": {
"title": "Q4 Launch Planning",
"level": "continent",
"colorMode": "categorical",
"paletteColor": "string",
"regions": [
{
"name": "Q4 Launch Planning",
"iso": "string",
"color": "string",
"value": 0,
"category": "string",
"description": "string"
}
],
"legend": [
{
"label": "string",
"color": "string"
}
]
}
}
Add one record
POST /boards/{boardId}/items/{itemId}/records adds one of these to an item already on a board and leaves the rest of it as it is. Send the same key again to update that record instead of adding another.
Record fields
regionstringrequiredA country, state or province by its name.
valuenumbercategorystringcolorstringdescriptionstringkeystringYour own id for this record, like an issue key. Sending the same key again updates and moves that record instead of adding another.
{
"record": {
"region": "string",
"value": 0,
"category": "string",
"color": "string",
"description": "string",
"key": "string"
}
}