Swetrix

Swetrix Funnels API

Manage conversion funnels

GitHub OpenAPI
Business capability
Product Usage Analytics BC-4280.30

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/project/funnels/{pid} List a project's saved funnels · List Funnels #
Ask an LLM
“Which conversion funnels have I already saved for this project?”
“Can I see every saved funnel definition in a project?”
Tell an agent
List the saved funnels for project {pid}.
Show all funnel definitions in project {pid}.
POST /v1/project/funnel Save a new conversion funnel · Create Funnel #
Ask an LLM
“How do I define a signup funnel as a sequence of pages?”
“Can I save a funnel so I don't have to re-enter the page steps each time?”
Tell an agent
Create a funnel named {name} in project {pid} with steps {steps}.
Save funnel {name} for project {pid} tracking pages {steps} in order.
PATCH /v1/project/funnel Rename a saved funnel or change its steps · Update Funnel #
Ask an LLM
“Can I add or reorder pages in a funnel I already saved?”
“Is it possible to rename an existing funnel?”
Tell an agent
Change the steps of saved funnel {id} in project {pid} to {steps}.
Rename saved funnel {id} in project {pid} to {name}.
DELETE /v1/project/funnel/{id}/{pid} Delete a saved funnel · Delete Funnel #
Ask an LLM
“How do I remove a funnel I no longer use?”
“Can I delete one saved funnel without affecting the others?”
Tell an agent destructive · confirm first
Delete funnel {id} from project {pid}.
Remove saved funnel {id} in project {pid}.
GET /v1/log/funnel Analyze conversion and drop-off through a funnel · Get Funnel Analysis #
Ask an LLM
“Where do visitors drop off between my homepage, signup and dashboard?”
“What percentage of people convert at each step of my saved funnel?”
Tell an agent
Show conversion and drop-off for saved funnel {funnelId} in project {pid} over {period}.
Analyze conversion through pages {pages} in project {pid} for {period}.

Documentation

📖
Documentation
https://swetrix.com/docs/statistics-api
📖
Documentation
https://swetrix.com/docs/admin-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/swetrix/refs/heads/main/openapi/swetrix-funnels-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/swetrix/refs/heads/main/overlays/swetrix-funnels-api-overlay.yaml
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/swetrix/refs/heads/main/postman/swetrix-funnels-api.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/swetrix/refs/heads/main/collections/swetrix-funnels-api.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/swetrix:swetrix-funnels-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

swetrix-funnels-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Swetrix Funnels API
  version: '1.0'
  contact:
    name: Swetrix Support
    url: https://swetrix.com/contact
  license:
    name: AGPL-3.0
    url: https://github.com/Swetrix/swetrix-api/blob/main/LICENSE
  termsOfService: https://swetrix.com/privacy
  description: 'Operations tagged Funnels across 2 of this provider''s published API definitions: swetrix-admin-api-openapi.yml, swetrix-statistics-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.swetrix.com
  description: Swetrix Production API
security:
- ApiKeyAuth: []
tags:
- name: Funnels
  description: Manage conversion funnels
paths:
  /v1/project/funnels/{pid}:
    get:
      operationId: listFunnels
      summary: List Funnels
      description: Retrieves all saved funnels for a project.
      tags:
      - Funnels
      parameters:
      - name: pid
        in: path
        required: true
        schema:
          type: string
        description: Project ID
      responses:
        '200':
          description: Array of funnels
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Funnel'
        '401':
          $ref: '#/components/responses/Unauthorized'
    servers:
    - url: https://api.swetrix.com
      description: Swetrix Production API
  /v1/project/funnel:
    post:
      operationId: createFunnel
      summary: Create Funnel
      description: Creates a new conversion funnel for a project.
      tags:
      - Funnels
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFunnelRequest'
            example:
              name: Signup Funnel
              pid: abc123projectid
              steps:
              - /
              - /pricing
              - /signup
              - /dashboard
      responses:
        '201':
          description: Funnel created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Funnel'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
    patch:
      operationId: updateFunnel
      summary: Update Funnel
      description: Updates an existing funnel's name or page steps.
      tags:
      - Funnels
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFunnelRequest'
      responses:
        '200':
          description: Updated funnel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Funnel'
        '401':
          $ref: '#/components/responses/Unauthorized'
    servers:
    - url: https://api.swetrix.com
      description: Swetrix Production API
  /v1/project/funnel/{id}/{pid}:
    delete:
      operationId: deleteFunnel
      summary: Delete Funnel
      description: Removes a funnel from a project.
      tags:
      - Funnels
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Funnel ID
      - name: pid
        in: path
        required: true
        schema:
          type: string
        description: Project ID
      responses:
        '204':
          description: Funnel deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
    servers:
    - url: https://api.swetrix.com
      description: Swetrix Production API
  /v1/log/funnel:
    get:
      operationId: getFunnelAnalysis
      summary: Get Funnel Analysis
      description: Returns funnel conversion analysis for a specified sequence of pages. Shows conversion counts, dropoffs, and percentages at each step. Accepts either a saved funnel ID or an inline pages array.
      tags:
      - Funnels
      parameters:
      - $ref: '#/components/parameters/pid'
      - $ref: '#/components/parameters/period'
      - $ref: '#/components/parameters/from'
      - $ref: '#/components/parameters/to'
      - $ref: '#/components/parameters/timezone'
      - name: pages
        in: query
        schema:
          type: string
        description: JSON array of page paths (e.g. ["/","/signup","/dashboard"])
      - name: funnelId
        in: query
        schema:
          type: string
        description: Saved funnel ID
      responses:
        '200':
          description: Funnel step analysis
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FunnelResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
    servers:
    - url: https://api.swetrix.com
      description: Swetrix Production API
components:
  schemas:
    UpdateFunnelRequest:
      type: object
      required:
      - id
      - pid
      properties:
        id:
          type: string
        pid:
          type: string
        name:
          type: string
          maxLength: 50
        steps:
          type: array
          items:
            type: string
    Funnel:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        pid:
          type: string
        steps:
          type: array
          items:
            type: string
    CreateFunnelRequest:
      type: object
      required:
      - name
      - pid
      - steps
      properties:
        name:
          type: string
          maxLength: 50
        pid:
          type: string
        steps:
          type: array
          items:
            type: string
          description: Array of page paths defining funnel sequence
    FunnelStep:
      type: object
      properties:
        page:
          type: string
        count:
          type: integer
        dropoff:
          type: integer
        conversionRate:
          type: number
          format: float
    FunnelResponse:
      type: object
      properties:
        steps:
          type: array
          items:
            $ref: '#/components/schemas/FunnelStep'
  responses:
    BadRequest:
      description: Bad request - malformed body or missing required fields
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
    Unauthorized:
      description: Unauthorized - missing or invalid API key
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
  parameters:
    to:
      name: to
      in: query
      schema:
        type: string
        format: date
      description: Custom range end date (YYYY-MM-DD)
    timezone:
      name: timezone
      in: query
      schema:
        type: string
        default: Etc/GMT
      description: IANA timezone name (default Etc/GMT)
    pid:
      name: pid
      in: query
      required: true
      schema:
        type: string
      description: Project ID
    from:
      name: from
      in: query
      schema:
        type: string
        format: date
      description: Custom range start date (YYYY-MM-DD)
    period:
      name: period
      in: query
      required: true
      schema:
        type: string
        enum:
        - 1h
        - today
        - yesterday
        - 1d
        - 7d
        - 4w
        - 3M
        - 12M
        - 24M
        - all
      description: Time period for the query
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: API key from Swetrix account settings (https://swetrix.com/user-settings)
x-refined-from:
- swetrix-admin-api-openapi.yml
- swetrix-statistics-api-openapi.yml