Sweep

Sweep Funnel Maps API

The Funnel Maps API from Sweep — 9 operation(s) for funnel maps.

GitHub OpenAPI

Operations 11

GET /funnel-maps #
POST /funnel-maps #
GET /funnel-maps/{id} #
DELETE /funnel-maps/{id} #
GET /funnel-maps/{id}/fields #
PUT /funnel-maps/{funnelMapId} #
PATCH /funnel-maps/{id}/isPinned #
POST /funnel-maps/ai-process-mining #
POST /funnel-maps/links #
GET /funnel-maps/metadata/{metadataId} #
POST /funnel-maps/pills #

Documentation

📖
APIReference
https://api.sweep.io/api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/authentication/sweep-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/openapi/sweep-funnel-maps-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/conventions/sweep-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/data-model/sweep-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/errors/sweep-problem-types.yml

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/sweep-funnel-maps-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

sweep-funnel-maps-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sweep Funnel Maps API
  description: This is a publicly available Sweep API.
  version: '0.1'
  contact: {}
servers:
- url: https://api.sweep.io
  description: Sweep production API — the host this document was harvested from (GET /api-json); /health responds here
tags:
- name: Funnel Maps
paths:
  /funnel-maps:
    get:
      operationId: FunnelMapsController_getAllFunnelMaps
      parameters:
      - name: includeFunnelsData
        required: true
        in: query
        schema:
          type: boolean
      - name: includeFunnelId
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Funnel Maps
    post:
      operationId: FunnelMapsController_createFunnelMap
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFunnelMapDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      tags:
      - Funnel Maps
  /funnel-maps/{id}:
    get:
      operationId: FunnelMapsController_getOneFunnelMap
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: includeFunnelsData
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Funnel Maps
    delete:
      operationId: FunnelMapsController_deleteOneFunnelMap
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Funnel Maps
  /funnel-maps/{id}/fields:
    get:
      operationId: FunnelMapsController_getFunnelMapFields
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Funnel Maps
  /funnel-maps/{funnelMapId}:
    put:
      operationId: FunnelMapsController_updateFunnelMap
      parameters:
      - name: funnelMapId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFunnelMapDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Funnel Maps
  /funnel-maps/{id}/isPinned:
    patch:
      operationId: FunnelMapsController_updateFunnelMapIsPinned
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Funnel Maps
  /funnel-maps/ai-process-mining:
    post:
      operationId: FunnelMapsController_createAiProcessMiningFunnels
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAiProcessMiningFunnelsDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      tags:
      - Funnel Maps
  /funnel-maps/links:
    post:
      operationId: FunnelMapsController_enrichMetadataElements
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrichMetadataElementsRequestDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      tags:
      - Funnel Maps
  /funnel-maps/metadata/{metadataId}:
    get:
      operationId: FunnelMapsController_getMetadataElementCard
      parameters:
      - name: metadataId
        required: true
        in: path
        schema:
          type: string
      - name: crmOrgId
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Funnel Maps
  /funnel-maps/pills:
    post:
      operationId: FunnelMapsController_calculatePills
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculatePillsDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      tags:
      - Funnel Maps
components:
  schemas:
    UpdateHubspotFunnelMapMember:
      type: object
      properties:
        id:
          type: string
        sectionId:
          type: string
          format: uuid
        objectName:
          type: string
        leadingFieldName:
          type: string
        row:
          type: number
        column:
          type: number
      required:
      - id
      - sectionId
      - objectName
      - leadingFieldName
      - row
      - column
    OrgPillFunnelsDto:
      type: object
      properties:
        crmOrgId:
          type: string
        funnels:
          type: array
          items:
            $ref: '#/components/schemas/PillFunnelDto'
      required:
      - crmOrgId
      - funnels
    UpdateStickyNote:
      type: object
      properties:
        stickyNoteId:
          type: string
          format: uuid
        sectionId:
          type: string
          format: uuid
        backgroundColor:
          type: string
        richText:
          type: string
        xyPosition:
          $ref: '#/components/schemas/FreePositionDto'
        width:
          type: number
        height:
          type: number
        textScale:
          type: number
      required:
      - stickyNoteId
      - sectionId
      - backgroundColor
      - richText
      - xyPosition
      - width
      - height
      - textScale
    CreateFunnelMapDto:
      type: object
      properties:
        name:
          type: string
        defaultCrmOrgId:
          type: string
        funnels:
          type: array
          items:
            $ref: '#/components/schemas/UpdateFunnelMapMember'
        recordTypes:
          type: array
          items:
            $ref: '#/components/schemas/UpdateRecordTypeMapMember'
        hubspotFunnels:
          type: array
          items:
            $ref: '#/components/schemas/UpdateHubspotFunnelMapMember'
        thirdPartyFunnels:
          type: array
          items:
            $ref: '#/components/schemas/UpdateThirdPartyFunnelMapMember'
        metadataElements:
          type: array
          items:
            $ref: '#/components/schemas/UpdateMetadataElementMapMember'
        stickyNotes:
          type: array
          items:
            $ref: '#/components/schemas/UpdateStickyNote'
        texts:
          type: array
          items:
            $ref: '#/components/schemas/UpdateText'
        sections:
          type: array
          items:
            $ref: '#/components/schemas/UpdateSection'
      required:
      - name
      - defaultCrmOrgId
      - funnels
    UpdateRecordTypeMapMember:
      type: object
      properties:
        recordTypeName:
          type: string
        sectionId:
          type: string
          format: uuid
        objectName:
          type: string
        row:
          type: number
        column:
          type: number
        leadingFieldName:
          type: string
      required:
      - recordTypeName
      - sectionId
      - objectName
      - row
      - column
      - leadingFieldName
    UpdateThirdPartyFunnelMapMember:
      type: object
      properties:
        thirdPartyFunnelId:
          type: string
        sectionId:
          type: string
          format: uuid
        row:
          type: number
        column:
          type: number
      required:
      - thirdPartyFunnelId
      - sectionId
      - row
      - column
    PillFunnelDto:
      type: object
      properties:
        id:
          type: string
        objectName:
          type: string
        leadingFieldName:
          type: string
        recordTypeId:
          type: string
        stages:
          type: array
          items:
            $ref: '#/components/schemas/PillStageDto'
      required:
      - id
      - objectName
      - leadingFieldName
      - recordTypeId
      - stages
    EnrichMetadataElementsRequestDto:
      type: object
      properties:
        targets:
          type: array
          items:
            type: object
        context:
          type: array
          items:
            type: object
        parentElementId:
          type: string
        commonChildId:
          type: string
      required:
      - targets
    UpdateFunnelMapDto:
      type: object
      properties:
        version:
          type: number
        name:
          type: string
        defaultCrmOrgId:
          type: string
        funnels:
          type: array
          items:
            $ref: '#/components/schemas/UpdateFunnelMapMember'
        recordTypes:
          type: array
          items:
            $ref: '#/components/schemas/UpdateRecordTypeMapMember'
        hubspotFunnels:
          type: array
          items:
            $ref: '#/components/schemas/UpdateHubspotFunnelMapMember'
        thirdPartyFunnels:
          type: array
          items:
            $ref: '#/components/schemas/UpdateThirdPartyFunnelMapMember'
        metadataElements:
          type: array
          items:
            $ref: '#/components/schemas/UpdateMetadataElementMapMember'
        stickyNotes:
          type: array
          items:
            $ref: '#/components/schemas/UpdateStickyNote'
        texts:
          type: array
          items:
            $ref: '#/components/schemas/UpdateText'
        sections:
          type: array
          items:
            $ref: '#/components/schemas/UpdateSection'
      required:
      - version
      - name
      - defaultCrmOrgId
      - funnels
    UpdateText:
      type: object
      properties:
        textId:
          type: string
          format: uuid
        sectionId:
          type: string
          format: uuid
        richText:
          type: string
        xyPosition:
          $ref: '#/components/schemas/FreePositionDto'
        width:
          type: number
        height:
          type: number
        textScale:
          type: number
      required:
      - textId
      - sectionId
      - richText
      - xyPosition
      - width
      - height
      - textScale
    FreePositionDto:
      type: object
      properties:
        x:
          type: number
        y:
          type: number
      required:
      - x
      - y
    UpdateFunnelMapMember:
      type: object
      properties:
        funnelId:
          type: string
        sectionId:
          type: string
          format: uuid
        row:
          type: number
        column:
          type: number
      required:
      - funnelId
      - sectionId
      - row
      - column
    UpdateSection:
      type: object
      properties:
        sectionId:
          type: string
          format: uuid
        backgroundColor:
          type: string
        name:
          type: string
        xyPosition:
          $ref: '#/components/schemas/FreePositionDto'
        width:
          type: number
        height:
          type: number
      required:
      - sectionId
      - backgroundColor
      - name
      - xyPosition
      - width
      - height
    CreateAiProcessMiningFunnelsDto:
      type: object
      properties:
        objectName:
          type: string
      required:
      - objectName
    PillStageDto:
      type: object
      properties:
        stageId:
          type: string
        stageName:
          type: string
      required:
      - stageId
      - stageName
    FunnelLinkDto:
      type: object
      properties:
        _id:
          type: string
        _type:
          type: string
          enum:
          - salesforce
          - thirdParty
          - recordType
          - hubspot
          - metadataElement
        funnelId:
          type: string
        stageId:
          type: string
      required:
      - _id
      - _type
      - funnelId
    UpdateMetadataElementMapMember:
      type: object
      properties:
        metadataId:
          type: string
        sectionId:
          type: string
          format: uuid
        crmOrgId:
          type: string
        row:
          type: number
        column:
          type: number
        funnelLinks:
          type: array
          items:
            $ref: '#/components/schemas/FunnelLinkDto'
        color:
          type: string
        icon:
          type: string
      required:
      - metadataId
      - sectionId
      - crmOrgId
      - row
      - column
      - funnelLinks
    CalculatePillsDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/OrgPillFunnelsDto'
      required:
      - items
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http