---
title: "The project's funnel"
method: GET
path: "/v1/projects/{project}/links/funnel"
tags: ["Smart Links"]
---

# The project's funnel

`GET /v1/projects/{project}/links/funnel`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/links/funnel`
- Auth: HTTP bearer

```bash
curl https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/links/funnel \
  -H "Authorization: Bearer sbt_..."
```

Every link, live and archived, each with its lifetime `clicks`, `leads` (the members it brought), `checkouts` (those who started a purchase, in any state), `paid` (those who made a successful payment), `conversion_rate` (paid per hundred clicks) and `revenue` (everything those members ever paid, per currency and restated in US dollars); the `direct` row for the members no link brought; and `totals`, which equal the project's own figures, so the rows add up.

> 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.

## Path parameters

- `project` string, uuid, required

## Response `200`

`links`, `direct` and `totals`; the totals are the project's own figures, so the rows add up.

- object
  - `data` object, required: The response's payload.
    - `links` array[], required: One funnel row per Smart Link of the project, live and archived alike, newest first.
      - unknown[]
        - unknown
    - `direct` unknown[], required: The Direct row: the members no link brought, counted the same way, with `link_id` and `slug` null.
      - unknown
    - `totals` object, required: The sum of every row above, which equals the project's own figures.
      - `clicks` integer, required: Every link's lifetime clicks added up; the Direct row has none.
      - `leads` integer, required: Every member of the project, credited to a link or Direct.
      - `checkouts` integer, required: Those members who started at least one purchase.
      - `paid` integer, required: Those members who made at least one successful payment.
      - `revenue_usd` string, required: Everything they ever paid, restated in US dollars, a decimal string with two places.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)