Pirsch

Pirsch Funnels API

Define and manage multi-step conversion funnels

GitHub OpenAPI

Operations 3

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 /funnel List a domain's funnels · List funnels #
Ask an LLM
“Which funnels have I defined for my site?”
“Can I search my funnels by name?”
Tell an agent
List the funnels for domain {id}.
Find funnels on domain {id} matching {search}.
POST /funnel Create or edit a funnel's steps · Create or update funnel #
Ask an LLM
“How do I build a signup funnel from landing page to confirmation?”
“Can I change the steps of a funnel I already created?”
Tell an agent
Create a funnel {name} on domain {domain_id} with steps {steps}.
Update funnel {id} on domain {domain_id} to be named {name} with steps {steps}.
DELETE /funnel Delete a funnel · Delete funnel #
Ask an LLM
“How can I remove a funnel I no longer use?”
“Does deleting a funnel affect my other site statistics?”
Tell an agent destructive · confirm first
Delete funnel {id}.
Remove the funnel {id} from my site.

Documentation

📖
Documentation
https://docs.pirsch.io/api-sdks/api-v1

Specifications

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

Other Resources

🔗
APIGuide
https://docs.pirsch.io/api-sdks/api-guide-v1
🔗
SDKs
https://docs.pirsch.io/api-sdks/sdks

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/pirsch:pirsch-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

pirsch-funnels-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pirsch Funnels API
  description: RESTful API for sending page views, events, and session data to Pirsch, and for querying statistics including visitors, pages, referrers, UTM parameters, geo-location, device, browser, conversion goals, funnels, and real-time active visitors. Also exposes management endpoints for domains, members, clients, webhooks, email reports, traffic filters, short links, and views.
  version: '1'
  contact:
    name: Pirsch Support
    url: https://pirsch.io
  license:
    name: Proprietary
    url: https://pirsch.io/privacy
servers:
- url: https://api.pirsch.io/api/v1
  description: Pirsch production API
security:
- BearerAuth: []
tags:
- name: Funnels
  description: Define and manage multi-step conversion funnels
paths:
  /funnel:
    get:
      operationId: listFunnels
      summary: List funnels
      tags:
      - Funnels
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: string
        description: Domain ID
      - name: search
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Funnels
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Funnel'
    post:
      operationId: createOrUpdateFunnel
      summary: Create or update funnel
      tags:
      - Funnels
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFunnelRequest'
      responses:
        '200':
          description: Funnel saved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Funnel'
    delete:
      operationId: deleteFunnel
      summary: Delete funnel
      tags:
      - Funnels
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Funnel deleted
components:
  schemas:
    CreateFunnelRequest:
      type: object
      required:
      - domain_id
      - name
      - steps
      properties:
        domain_id:
          type: string
        id:
          type: string
        name:
          type: string
        steps:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              filter:
                type: object
    Funnel:
      type: object
      properties:
        id:
          type: string
        domain_id:
          type: string
        name:
          type: string
        steps:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              filter:
                type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Pass an OAuth2 access token obtained from POST /token, or a static access key, as a Bearer token in the Authorization header.