> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iqrush.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Read the AI referral funnel

> Read the ecommerce stages recorded for AI-referred activity.

Read the ecommerce stages recorded for AI-referred activity.

**MCP tool:** `get_ecommerce_funnel`. **Operation:** read. Uses the authorized connection; no project or content changes are made by this tool.

## Parameters

| Name | Type | Required | Default | Meaning and accepted values |
| - | - | - | - | - |
| `project_id` | string | Yes | `Required` | Project ID from list\_projects. Select the project in the intended workspace and environment. |
| `start_date` | string | No | `'30daysAgo'` | Start of the requested range, as YYYY-MM-DD or a relative value such as 30daysAgo. These reads select a stored snapshot; use resolved\_window for the dates actually served. |
| `end_date` | string | No | `'today'` | End of the requested range, as YYYY-MM-DD or today. Check resolved\_window rather than treating the requested dates as the served period. |
| `session_source` | string or null | No | `null` | Restrict rows to one AI referral source, such as a source returned by get\_ai\_traffic\_sources. Omit to leave source unrestricted. |
| `device_category` | string or null | No | `null` | Select desktop, mobile, or tablet for the ecommerce funnel. Omit to leave device category unrestricted. |

## Example call

Replace ID placeholders and example selections with values from your account. This is the `params` object for MCP `tools/call`.

```json theme={null}
{
  "name": "get_ecommerce_funnel",
  "arguments": {
    "project_id": "PROJECT_ID",
    "start_date": "2026-09-01",
    "end_date": "2026-09-30"
  }
}
```

## Read the response

Returns funnel data for `view_item`, `add_to_cart`, `begin_checkout`, and `purchase`, with available step rates and resolved snapshot context.

### Fields to use

These selected fields explain the example and the result to preserve. Field presence depends on the response; this is not a complete response schema.

| Field | Meaning and use |
| - | - |
| `linked` | Whether a property link exists for this project. |
| `funnel_steps` | Stored ecommerce funnel steps when available. Empty here means no linked data, not zero purchases. |

## Response example

Selected fields from an observed IQRush Dev response. Lists are shortened and project/run IDs are placeholders. Omitted fields remain available in the actual response.

```json theme={null}
{
  "project_id": "PROJECT_ID",
  "linked": false,
  "funnel_steps": []
}
```

This observed example has no linked Google property. It demonstrates the unavailable-integration response; it is not a zero-traffic report.

## Important behavior

Results depend on the property’s ecommerce event setup. An event count is not automatically a count of unique people.

Check tool and payload errors before using the result. [Response handling](/developers/guides/09-responses-and-metrics) explains estimates and empty results; [errors and recovery](/developers/guides/13-errors) covers invalid requests and temporary failures.

HTTP equivalent: [Read the AI referral funnel](/developers/http/http-get-ecommerce-funnel). HTTP parameters and defaults can differ.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.