SuperFunnel API

The SuperFunnel API is a REST API for the things you would otherwise do by hand in the dashboard: managing CMS content, reporting conversions that happen in your backend, exporting analytics, and uploading files.

Traffic also runs the other way. Webhooks push lead and event data from SuperFunnel to an endpoint you own, in real time.

Base URL: https://api.superfunnel.ai

Every endpoint speaks JSON, is scoped to a single account by the API token you send, and returns the same error shape.

Try requests from these pages

Each endpoint below has a Try it panel. Paste an API token once and you can fire real requests and read real responses without leaving the docs. The request goes straight from your browser to the API — the token stays in your browser tab and never reaches the documentation site.

Quickstart

Get an API token

Create an API token in Settings > Integrations > API keys. See Authentication for detailed instructions.

Make a request

Send the token in the x-api-key header with a Bearer prefix:

curl -X GET 'https://api.superfunnel.ai/v1/cms/collections' \
  -H 'x-api-key: Bearer YOUR_API_TOKEN'

Read the response

{
  "collections": [],
  "nextPageToken": null
}

A 200 means the token is valid and scoped to your account. A 401 means the token is missing, malformed, or revoked.

Endpoints

CMS collections

get/v1/cms/collectionsList collections

post/v1/cms/collectionsCreate a collection

get/v1/cms/collections/{collectionId}Get a collection

patch/v1/cms/collections/{collectionId}Update a collection

delete/v1/cms/collections/{collectionId}Delete a collection

CMS entries

get/v1/cms/collections/{collectionId}/entriesList entries

post/v1/cms/collections/{collectionId}/entriesCreate an entry

get/v1/cms/collections/{collectionId}/entries/{entryId}Get an entry

patch/v1/cms/collections/{collectionId}/entries/{entryId}Update an entry

delete/v1/cms/collections/{collectionId}/entries/{entryId}Delete an entry

Conversions

post/v1/analytics/report-conversionReport a conversion

get/v1/analytics/report-conversionReport a conversion by query string

Analytics

post/v1/analytics/exportStart an analytics export

Jobs

get/v1/jobs/get-by-idGet a job

Files

post/v1/files/uploadUpload a file

Where to go next

Authentication

How tokens work, and how to keep them safe.

CMS

Create collections and entries programmatically.

Conversions

Attribute backend conversions to the visit that caused them.

Errors

Status codes and the error response shape.