Version
READ

get_link_funnel

Read the funnel behind a project's Smart Links, one link or all of them with the Direct row and totals that add up to the project's own figures. Read-only, lifetime by design.

Answer "which channel pays?". For every link, or for one: lifetime clicks, the members the link brought (leads), those who started a purchase (checkouts), those who paid (paid), the conversion rate and everything those members ever paid, per currency and restated in US dollars. Without link_id the answer also carries the direct row for the members no link brought and totals that equal the project's own figures, so the rows add up.

Read-only. Never mutates anything.

The figures are lifetime by design and count removed members and ended purchases, so two channels compare on everything each ever brought. The dashboard's date window never narrows them.

Requires ability

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

Annotations

Read-only

It reads and never changes anything.

project_id*string

UUID of the project whose funnel to read.

link_idstringoptional

Optional UUID of one Smart Link; omit for every link with the Direct row and the totals.

{  "data": {    "links": [      {        "link_id": "7c2e5a90-3f41-4b8d-9e62-1a0d4c8b7f35",        "name": "YouTube description",        "slug": "youtube",        "archived": false,        "clicks": 42,        "leads": 9,        "checkouts": 4,        "paid": 3,        "conversion_rate": 7.14,        "revenue": { "usd": "36.00", "by_currency": [{ "currency_id": "6e2b1c4a-8d3f-4a9b-9c7e-2f1d3a5b7c9e", "currency": "USD", "amount": "36.00" }] }      }    ],    "direct": { "link_id": null, "name": "Direct", "slug": null, "archived": false, "clicks": 0, "leads": 120, "checkouts": 61, "paid": 55, "conversion_rate": 0, "revenue": { "usd": "660.00", "by_currency": [] } },    "totals": { "clicks": 42, "leads": 129, "checkouts": 65, "paid": 58, "revenue_usd": "696.00" }  }}

With link_id, data is that one row.

RESOURCE_NOT_FOUND

unknown project_id or link_id, or a link of another project.

AUTHENTICATION_REQUIRED

no authenticated user on the request.

TOKEN_MISSING_ABILITY

token lacks project-link:view-any.

How is this guide?

Last updated on