---
title: "Conversion Funnel API — Step-to-step rates | Imejis"
description: "Render conversion funnel images with step-to-step rates — each stage as a percentage of the previous — set per API call. Create conversion funnels free."
url: "https://www.imejis.io/components/funnel/step-conversion"
---

# Conversion Funnel API — Step-to-step rates | Imejis

Stage-to-stage conversion rates (previous) instead of share of the top.

## Use cases

- Onboarding step drop-off analysis
- Checkout step-conversion cards
- Activation step funnels

## Properties

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `data` | `object[]` | `[]` | Stages top→bottom: array of { label, value }. |
| `colors` | `color[]` | `[]` | One color per stage (falls back to shades of `color`). |
| `color` | `color` | `"#6366f1"` | Base color when colors is unset. |
| `labelColor` | `color` | `"#ffffff"` | Text color drawn on the bands. |
| `showValues` | `boolean` | `true` | Print each stage value. |
| `valueFormat` | `'number' \| 'compact' \| 'percent' \| 'currency'` | `"compact"` | How values are formatted (1,200 / 1.2K / 12% / $1,200). |
| `currencySymbol` | `string` | `"$"` | Symbol used with the 'currency' format. |
| `showPercent` | `boolean` | `false` | Print the conversion percentage per stage. |
| `percentOf` | `'first' \| 'previous'` | `"first"` | Percent basis: share of the first stage or of the previous stage. |
| `gap` | `number` (min 0) | `2` | Gap between bands (px). |
| `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)". |

## Design JSON (this variant)

```json
{
  "title": "Funnel sample",
  "description": "A signup conversion funnel",
  "dimensions": {
    "width": 800,
    "height": 420
  },
  "background": {
    "color": "#ffffff"
  },
  "components": [
    {
      "id": "sample-funnel",
      "key": "funnel",
      "type": "funnel",
      "position": {
        "x": 220,
        "y": 40
      },
      "rotation": 0,
      "size": {
        "width": 360,
        "height": 340
      },
      "dynamic": true,
      "properties": {
        "data": [
          {
            "label": "Visits",
            "value": 12000
          },
          {
            "label": "Signups",
            "value": 4200
          },
          {
            "label": "Trials",
            "value": 1800
          },
          {
            "label": "Paid",
            "value": 640
          }
        ],
        "color": "#6366f1",
        "showValues": true,
        "showPercent": true,
        "percentOf": "previous",
        "valueFormat": "compact",
        "opacity": 1
      }
    }
  ]
}
```

## Examples

### Checkout drop-off

Cart → Checkout → Payment → Complete with step conversion rates.

API overrides that reproduce this example:

```json
{
  "funnel.showPercent": true,
  "funnel.percentOf": "previous",
  "funnel.data": [
    {
      "label": "Cart",
      "value": 8600
    },
    {
      "label": "Checkout",
      "value": 5100
    },
    {
      "label": "Payment",
      "value": 3400
    },
    {
      "label": "Complete",
      "value": 2900
    }
  ],
  "funnel.color": "#0ea5e9",
  "funnel.valueFormat": "compact"
}
```

### Hiring pipeline

Applicants → Screen → Interview → Offer → Hired step-by-step.

API overrides that reproduce this example:

```json
{
  "funnel.showPercent": true,
  "funnel.percentOf": "previous",
  "funnel.data": [
    {
      "label": "Applied",
      "value": 420
    },
    {
      "label": "Screened",
      "value": 180
    },
    {
      "label": "Interviewed",
      "value": 64
    },
    {
      "label": "Offered",
      "value": 18
    },
    {
      "label": "Hired",
      "value": 12
    }
  ],
  "funnel.colors": [
    "#059669",
    "#0d9488",
    "#0891b2",
    "#2563eb",
    "#4f46e5"
  ],
  "funnel.valueFormat": "number"
}
```

## API overrides

Push fresh stages per render with '<key>.data' (or just '<key>') as [{ label, value }]; colors are overridable too.

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

```json
{
  "funnel.data": [
    {
      "label": "Visits",
      "value": 12000
    },
    {
      "label": "Signups",
      "value": 4200
    },
    {
      "label": "Trials",
      "value": 1800
    },
    {
      "label": "Paid",
      "value": 640
    }
  ],
  "funnel.color": "#6366f1",
  "funnel.showValues": true,
  "funnel.showPercent": true,
  "funnel.percentOf": "first",
  "funnel.valueFormat": "compact",
  "funnel.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 '{
    "funnel.data": [
        {
            "label": "Visits",
            "value": 12000
        },
        {
            "label": "Signups",
            "value": 4200
        },
        {
            "label": "Trials",
            "value": 1800
        },
        {
            "label": "Paid",
            "value": 640
        }
    ],
    "funnel.color": "#6366f1",
    "funnel.showValues": true,
    "funnel.showPercent": true,
    "funnel.percentOf": "first",
    "funnel.valueFormat": "compact",
    "funnel.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).

## Related

- [Funnel component](https://www.imejis.io/components/funnel.md) — full reference and FAQs
- [Dark](https://www.imejis.io/components/funnel/dark.md) — A vivid funnel on a dark canvas for social cards.