Skip to content
MockFlow DevelopersGet an API key

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.

Updated 9 Nov 20262 min read

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

data
titlestring

Short 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.

paletteColorstring

For 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[]required

Array of region objects to color

Child attributes
namestringrequired

Region's common English name

isostring

ISO code — alpha-3 for country level, ISO 3166-2 for state level; omit for continent/region levels

colorstring

Hex fill color "#RRGGBB" (categorical maps)

valuenumber

Underlying metric (gradient maps)

categorystring

Discrete group label (categorical maps)

descriptionstring

Optional short note (<= 80 chars)

legendobject[]

Key explaining the colors

Child attributes
labelstring
colorstring

Hex "#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

record
regionstringrequired

A country, state or province by its name.

valuenumber
categorystring
colorstring
descriptionstring
keystring

Your 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"
  }
}
Was this page helpful?

Sign in to MockFlow

The same account you use in the app and on the API.

Forgot your password?
or
Continue with GoogleContinue with MicrosoftContinue with Apple