---
title: "An ordered funnel over catalog steps, with a window and an optional breakdown."
method: GET
path: "/api/v1/admin/metrics/funnel"
tags: ["Metrics Admin"]
---

# An ordered funnel over catalog steps, with a window and an optional breakdown.

`GET /api/v1/admin/metrics/funnel`

## Request

- Base URL: `https://api.avatarfactory.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.avatarfactory.io/api/v1/admin/metrics/funnel`
- Auth: one of:
  - API key in cookie `session`
  - HTTP bearer

## Query parameters

- `tz` string, nullable
- `include_internal` '0' | '1', nullable
- `from` string, date, nullable
- `to` string, date, nullable
- `filters` string, nullable
- `steps` string, nullable
- `window_days` integer
- `breakdown` 'none' | 'device' | 'country' | 'source' | 'plan'

## Response `200`

OK

- FunnelResponse
  - `breakdown` 'none' | 'device' | 'country' | 'source' | 'plan', required
  - `compare` 'previous' | 'yoy' | 'none', required
  - `compare_from` string, date, nullable, required
  - `compare_to` string, date, nullable, required
  - `currency` 'USD'
  - `env` 'production' | 'staging' | 'local' | 'test', required
  - `estimated_before` string, date, nullable
  - `filters` FilterEcho[]
    - `dimension` string, required
    - `op` 'is' | 'not', required
    - `values` string[], required
  - `freshness` FreshnessSummary, required
    - `is_mrr_carried` boolean, required
    - `is_stale` boolean, required
    - `last_success_at` string, date-time, nullable, required
    - `subscription_state_day` string, date, nullable, required
  - `from` string, date, required
  - `granularity` 'day' | 'week' | 'month', required
  - `meta` FunnelMeta, required
    - `definition` string, required
    - `tz` string, required
    - `tz_applied` boolean
  - `notes` string[]
  - `segments` FunnelSegment[], required
    - `is_other` boolean, required
    - `steps` FunnelStepResult[], required
      - `count` integer, required
      - `dropped` integer, nullable, required
      - `index` integer, required
      - `label` string, required
      - `median_seconds_from_previous` integer, nullable, required
      - `pct_of_first` number, nullable, required
      - `pct_of_previous` number, nullable, required
      - `step_id` string, required
    - `value` string, required
  - `steps` FunnelStepResult[], required
    - `count` integer, required
    - `dropped` integer, nullable, required
    - `index` integer, required
    - `label` string, required
    - `median_seconds_from_previous` integer, nullable, required
    - `pct_of_first` number, nullable, required
    - `pct_of_previous` number, nullable, required
    - `step_id` string, required
  - `steps_requested` string[], required
  - `summary` FunnelSummary, required
    - `first_to_last_pct` number, nullable, required
    - `signups` integer, required
    - `visit_to_signup_pct` number, nullable, required
    - `visits` integer, required
  - `to` string, date, required
  - `window_days` integer, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `422`: Unprocessable Entity
- `503`: Service Unavailable

---

[API](https://skmtc.dev/avatarfactory/apis/avatarfactory-api.md) · [All operations](https://skmtc.dev/avatarfactory/apis/avatarfactory-api/llms.txt) · [OpenAPI document](https://skmtc.dev/avatarfactory/apis/avatarfactory-api/revisions/66fc7aa3f296?raw)