---
title: "Progress Bar Image API — Bars, rings & gauges | Imejis"
description: "Render progress as a bar, ring or gauge with a percent label, driven by a fresh value on every API call. Start generating progress images free today."
url: "https://www.imejis.io/components/progress"
---

# Progress Bar Image API — Bars, rings & gauges | Imejis

A progress indicator as a linear bar, circular ring or gauge, with an optional percent/value/fraction label. Great for goals, capacity and completion visuals.

## Use cases

- Fundraising and goal-tracker images that update with every donation
- Course completion certificates and learner progress emails
- Capacity and quota usage visuals for status reports
- Challenge streak images for social sharing

## Authoring notes

- Use a wide box for linear, a square box for circular and gauge.
- max defaults to 100 so value reads as a percent.

## Properties

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `value` | `number` (min 0) | `60` | Current progress value. |
| `max` | `number` (min 1) | `100` | Value that represents 100%. |
| `variant` | `'linear' \| 'circular' \| 'gauge'` | `"linear"` | Visual style: bar, ring or gauge. |
| `orientation` | `'horizontal' \| 'vertical'` | `"horizontal"` | Direction of the linear bar. |
| `fillColor` | `color` | `"#4F46E5"` | Color of the filled portion. |
| `trackColor` | `color` | `"#E5E7EB"` | Color of the unfilled track. |
| `rounded` | `boolean` | `true` | Round the ends of the bar/ring. |
| `thickness` | `number` (min 0) | `0` | Bar/ring thickness in pixels (0 = auto). |
| `showValue` | `boolean` | `true` | Show the numeric label alongside the indicator. |
| `valueFormat` | `'percent' \| 'value' \| 'fraction'` | `"percent"` | Format of the numeric label (72%, 72, or 72/100). |
| `valueColor` | `color` | `"#374151"` | Color of the numeric label. |
| `opacity` | `number` | `1` | Overall component opacity from 0 (transparent) to 1 (opaque). |
| `borderWidth` | `number` | `0` | Border thickness in pixels around the component. |
| `borderColor` | `color` | `"transparent"` | Border color (any CSS color). |
| `borderStyle` | `'solid' \| 'dashed' \| 'dotted' \| 'double' \| 'none'` | `"solid"` | Border line style. |
| `borderRadius` | `number` | `0` | Corner radius in pixels. |
| `boxShadow` | `string` | — | CSS box-shadow applied to the component, e.g. "0 4px 6px rgba(0,0,0,0.1)". |

## Sample design JSON

```json
{
  "title": "Progress sample",
  "description": "A dynamic progress bar",
  "dimensions": {
    "width": 800,
    "height": 420
  },
  "background": {
    "color": "#ffffff"
  },
  "components": [
    {
      "id": "sample-progress",
      "key": "completion",
      "type": "progress",
      "position": {
        "x": 200,
        "y": 192
      },
      "rotation": 0,
      "size": {
        "width": 400,
        "height": 36
      },
      "dynamic": true,
      "properties": {
        "value": 72,
        "max": 100,
        "variant": "linear",
        "orientation": "horizontal",
        "fillColor": "#4F46E5",
        "trackColor": "#E5E7EB",
        "rounded": true,
        "showValue": true,
        "valueFormat": "percent",
        "valueColor": "#374151",
        "opacity": 1
      }
    }
  ]
}
```

## Examples

### Fundraising goal tracker

A donation drive at 84% of its $10,000 goal, ready for a campaign update email.

API overrides that reproduce this example:

```json
{
  "completion.value": 8420,
  "completion.max": 10000,
  "completion.fillColor": "#10B981",
  "completion.valueFormat": "percent"
}
```

### Storage quota warning

An account at 87% of its storage allowance, amber-filled for a heads-up email.

API overrides that reproduce this example:

```json
{
  "completion.value": 87,
  "completion.fillColor": "#F59E0B",
  "completion.valueColor": "#B45309"
}
```

## API overrides

Drive the bar with '<key>.value' (or just '<key>'); max, fill/track colors and valueFormat are overridable per render.

Flat override payload (`key.property` addressing) with the sample design's current values — send only the keys you want to change:

```json
{
  "completion.value": 72,
  "completion.max": 100,
  "completion.variant": "linear",
  "completion.orientation": "horizontal",
  "completion.fillColor": "#4F46E5",
  "completion.trackColor": "#E5E7EB",
  "completion.rounded": true,
  "completion.showValue": true,
  "completion.valueFormat": "percent",
  "completion.valueColor": "#374151",
  "completion.opacity": 1
}
```

```bash
curl --location 'https://render.imejis.io/v1/{{YOUR_DESIGN_ID}}' \
--header 'dma-api-key: {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
    "completion.value": 72,
    "completion.max": 100,
    "completion.variant": "linear",
    "completion.orientation": "horizontal",
    "completion.fillColor": "#4F46E5",
    "completion.trackColor": "#E5E7EB",
    "completion.rounded": true,
    "completion.showValue": true,
    "completion.valueFormat": "percent",
    "completion.valueColor": "#374151",
    "completion.opacity": 1
}'
```

`{{YOUR_DESIGN_ID}}` and `{{YOUR_API_KEY}}` are placeholders: first create
the design in your account (paste the sample design JSON above into the
editor at https://app.imejis.io, or create it programmatically via the
imejis MCP server's `create_design` + `update_design` tools), then render
it with the design's id and one of your API keys.

Agents: the MCP server at https://api.imejis.io/api/mcp exposes this same
catalog as structured data via the `list_component_types` tool (property
kinds, allowed values, bounds, ready-to-use sample designs).

## Frequently Asked Questions

### Can I update the progress value per API call?

Yes — send '<key>.value' (or just the key); max, fill and track colors and valueFormat can be overridden per render as well.

### What visual styles are available?

The variant property switches between a linear bar (horizontal or vertical), a circular ring and a half-circle gauge.

### How do I show 72% as a label?

Turn on showValue and choose a valueFormat: 'percent' renders 72%, 'value' renders 72 and 'fraction' renders 72/100.

### Can values use a scale other than 0-100?

Yes — max defines what counts as 100%, so a value of 350 with max 500 fills the indicator to 70%.

## Variants

- [Circular](https://www.imejis.io/components/progress/circular.md) — A progress ring with the value in the center.
- [Gauge](https://www.imejis.io/components/progress/gauge.md) — A half-circle gauge — speedometer-style capacity and score visuals.
- [Vertical bar](https://www.imejis.io/components/progress/vertical-bar.md) — A linear bar filling bottom-to-top.

All components: https://www.imejis.io/components.md