---
title: "Get funnel analytics"
method: POST
path: "/funnels/getAnalytics"
tags: ["Funnels"]
---

# Get funnel analytics

`POST /funnels/getAnalytics`

## Request

- Base URL: `https://api.databuddy.cc`
- URL: `https://api.databuddy.cc/funnels/getAnalytics`
- Auth: API key in header `x-api-key`

Returns funnel conversion analytics. Requires website read permission.

## Request body

- object
  - `startDate` string, date
  - `endDate` string, date
  - `cohort` object: Read-only cohort. Funnel filters select first-step visitors; subsequent ordered steps may have different context. Goal filters select page-view visitors and matching completions. Saved filters are ANDed. Use the referrer breakdown tool to compare source groups. These are visitors, not attempts.
    - `filters` object[], required
      - `field` 'browser_name' | 'device_type' | 'os_name' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign', required
      - `operator` 'equals' | 'not_equals' | 'in' | 'not_in', required
      - `value` union, required
        - string
        - string[]
  - `funnelId` string, required
  - `websiteId` string, required

## Response `200`

OK

- object
  - `overall_conversion_rate` number, required
  - `total_users_entered` number, required
  - `total_users_completed` number, required
  - `avg_completion_time` number, required
  - `avg_completion_time_formatted` string, required
  - `biggest_dropoff_step` number, required
  - `biggest_dropoff_rate` number, required
  - `duration_available` boolean, required
  - `steps_analytics` object[], required
    - `step_number` number, required
    - `step_name` string, required
    - `users` number, required
    - `total_users` number, required
    - `conversion_rate` number, required
    - `dropoffs` number, required
    - `dropoff_rate` number, required
    - `avg_time_to_complete` number, required
    - `error_context_available` boolean, required
    - `error_count` number, required
    - `error_rate` number, required
    - `top_errors` object[], required
      - `message` string, required
      - `error_type` string, required
      - `count` number, required
  - `time_series` object[]
    - `date` string, required
    - `users` number, required
    - `conversions` number, required
    - `conversion_rate` number, required
    - `dropoffs` number, required
    - `avg_time` number, required
  - `error_insights` object, required
    - `available` boolean, required
    - `total_errors` number, required
    - `sessions_with_errors` number, required
    - `dropoffs_with_errors` number, required
    - `error_correlation_rate` number, required
  - `measurement` object, required
    - `websiteId` string, required
    - `definitionId` string, required
    - `startDate` string, date, required
    - `endDate` string, date, required
    - `definition` union, required
      - object
        - `type` 'PAGE_VIEW' | 'EVENT' | 'CUSTOM', required
        - `target` string, required
        - `filters` object[]
          - `field` 'event_name' | 'path' | 'referrer' | 'country' | 'city' | 'device_type' | 'browser_name' | 'os_name' | 'language' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'utm_term' | 'utm_content' | 'user_agent' | 'screen_resolution', required
          - `operator` 'equals' | 'contains' | 'not_contains' | 'starts_with' | 'ends_with' | 'not_equals' | 'in' | 'not_in', required
          - `value` union, required
            - string
            - string[]
      - object
        - `steps` object[], required
          - `type` 'PAGE_VIEW' | 'EVENT' | 'CUSTOM', required
          - `target` string, required
          - `name` string, required
          - `conditions` object
        - `filters` object[]
          - `field` 'event_name' | 'path' | 'referrer' | 'country' | 'city' | 'device_type' | 'browser_name' | 'os_name' | 'language' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'utm_term' | 'utm_content' | 'user_agent' | 'screen_resolution', required
          - `operator` 'equals' | 'contains' | 'not_contains' | 'starts_with' | 'ends_with' | 'not_equals' | 'in' | 'not_in', required
          - `value` union, required
            - string
            - string[]
  - `savedDefinition` union, required
    - object
      - `type` 'PAGE_VIEW' | 'EVENT' | 'CUSTOM', required
      - `target` string, required
      - `filters` object[]
        - `field` 'event_name' | 'path' | 'referrer' | 'country' | 'city' | 'device_type' | 'browser_name' | 'os_name' | 'language' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'utm_term' | 'utm_content' | 'user_agent' | 'screen_resolution', required
        - `operator` 'equals' | 'contains' | 'not_contains' | 'starts_with' | 'ends_with' | 'not_equals' | 'in' | 'not_in', required
        - `value` union, required
          - string
          - string[]
    - object
      - `steps` object[], required
        - `type` 'PAGE_VIEW' | 'EVENT' | 'CUSTOM', required
        - `target` string, required
        - `name` string, required
        - `conditions` object
      - `filters` object[]
        - `field` 'event_name' | 'path' | 'referrer' | 'country' | 'city' | 'device_type' | 'browser_name' | 'os_name' | 'language' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'utm_term' | 'utm_content' | 'user_agent' | 'screen_resolution', required
        - `operator` 'equals' | 'contains' | 'not_contains' | 'starts_with' | 'ends_with' | 'not_equals' | 'in' | 'not_in', required
        - `value` union, required
          - string
          - string[]
  - `cohort` object: Read-only cohort. Funnel filters select first-step visitors; subsequent ordered steps may have different context. Goal filters select page-view visitors and matching completions. Saved filters are ANDed. Use the referrer breakdown tool to compare source groups. These are visitors, not attempts.
    - `filters` object[], required
      - `field` 'browser_name' | 'device_type' | 'os_name' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign', required
      - `operator` 'equals' | 'not_equals' | 'in' | 'not_in', required
      - `value` union, required
        - string
        - string[]

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `403`: 403
- `404`: 404
- `409`: 409
- `429`: 429
- `500`: 500
- `503`: 503

---

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