Funnels
Create, manage, and run funnel configurations through the REST API.
Create, manage, and run session-based Funnel configurations. Results include visitor counts, conversion rates, drop-off rates, and session IDs for the selected date window.
GET/rest/v1/funnels
Authorization
apiKey Ours Privacy API key
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/funnels"{ "entities": [ { "funnelId": "cc36c810-1122-4842-933f-6c41b39cda1a", "name": "string", "description": "string", "queryDefinition": {}, "watched": true, "status": "READY", "reportDateRange": { "from": "string", "to": "string" }, "createdAt": "string", "updatedAt": "string" } ], "unavailableCount": 0, "warnings": [ "string" ]}POST/rest/v1/funnels
Authorization
apiKey Ours Privacy API key
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/rest/v1/funnels" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "queryDefinition": {} }'{ "funnelId": "cc36c810-1122-4842-933f-6c41b39cda1a", "name": "string", "description": "string", "queryDefinition": {}, "watched": true, "status": "READY", "reportDateRange": { "from": "string", "to": "string" }, "createdAt": "string", "updatedAt": "string"}GET/rest/v1/funnels/{id}
Authorization
apiKey Ours Privacy API key
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/funnels/string"{ "funnelId": "cc36c810-1122-4842-933f-6c41b39cda1a", "name": "string", "description": "string", "queryDefinition": {}, "watched": true, "status": "READY", "reportDateRange": { "from": "string", "to": "string" }, "createdAt": "string", "updatedAt": "string"}PATCH/rest/v1/funnels/{id}
Authorization
apiKey Ours Privacy API key
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/rest/v1/funnels/string" \ -H "Content-Type: application/json" \ -d '{}'{ "funnelId": "cc36c810-1122-4842-933f-6c41b39cda1a", "name": "string", "description": "string", "queryDefinition": {}, "watched": true, "status": "READY", "reportDateRange": { "from": "string", "to": "string" }, "createdAt": "string", "updatedAt": "string"}DELETE/rest/v1/funnels/{id}
Authorization
apiKey Ours Privacy API key
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/rest/v1/funnels/string"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "deleted": true}POST/rest/v1/funnels/{id}/duplicate
Authorization
apiKey Ours Privacy API key
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/rest/v1/funnels/string/duplicate"{ "funnelId": "cc36c810-1122-4842-933f-6c41b39cda1a", "name": "string", "description": "string", "queryDefinition": {}, "watched": true, "status": "READY", "reportDateRange": { "from": "string", "to": "string" }, "createdAt": "string", "updatedAt": "string"}GET/rest/v1/funnels/{id}/results
Authorization
apiKey Ours Privacy API key
In: header
Path Parameters
Query Parameters
Require this saved definition revision. Returns a conflict if the funnel has changed.
date-timeInclusive lower bound of the analysis window, as a UTC calendar day in YYYY-MM-DD format. The window may span at most 91 days including both endpoints.
^\d{4}-\d{2}-\d{2}$Inclusive upper bound of the analysis window, as a UTC calendar day in YYYY-MM-DD format. Must be on or after from, and the window may span at most 91 days including both endpoints.
^\d{4}-\d{2}-\d{2}$Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/funnels/string/results?from=2026-06-01&to=2026-06-30"{ "definitionUpdatedAt": "2019-08-24T14:15:22Z", "scope": { "timezone": "UTC", "entryFrom": "string", "entryTo": "string", "observationFrom": "string", "observationTo": "string", "windowMs": 1, "watermark": "string", "observationComplete": true, "settledEntryTo": "string" }, "semanticVersion": 1, "sourcePolicy": "events-v3-physical-key", "sourceRevision": "string", "sourceLimitations": [ "equal-load-conflicts-unverified" ], "engine": "string", "steps": [ { "stepNumber": 0, "visitorCount": 0, "conversionCount": 0, "conversionRate": 0, "dropOffRate": 0, "overallConversionRate": 0, "avgTimeToNextStep": 0, "sessionIds": [ "string" ], "dropOffSessionIds": [ "string" ], "visitorIds": [ "string" ], "dropOffVisitorIds": [ "string" ] } ], "totalVisitors": 0, "overallConversionRate": 0, "overallAvgTimeToConversion": 0}How is this guide?