CDPConsentExperimentationGuidesSupport

Funnels

List and retrieve funnel configurations, then fetch computed step analytics for any funnel over a date window.

List and retrieve funnel configurations, then fetch computed step analytics — visitor counts, conversion rates, drop-off rates, and session IDs — for any funnel over a date window.

GET
/rest/v1/funnels

Authorization

apiKey
AuthorizationBearer <token>

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",
      "steps": [
        {
          "stepId": "string",
          "name": "string",
          "eventName": "string",
          "order": 0,
          "filters": {}
        }
      ],
      "funnelType": "SESSION_BASED",
      "utmFilters": {},
      "conversionWindow": {
        "value": 0,
        "unit": "MINUTES"
      },
      "countingMethod": "UNIQUES",
      "stepOrder": "EXACT",
      "watched": true,
      "status": "READY",
      "reportDateRange": {
        "from": "string",
        "to": "string"
      },
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
GET
/rest/v1/funnels/{id}

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

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",
  "steps": [
    {
      "stepId": "string",
      "name": "string",
      "eventName": "string",
      "order": 0,
      "filters": {}
    }
  ],
  "funnelType": "SESSION_BASED",
  "utmFilters": {},
  "conversionWindow": {
    "value": 0,
    "unit": "MINUTES"
  },
  "countingMethod": "UNIQUES",
  "stepOrder": "EXACT",
  "watched": true,
  "status": "READY",
  "reportDateRange": {
    "from": "string",
    "to": "string"
  },
  "createdAt": "string",
  "updatedAt": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
GET
/rest/v1/funnels/{id}/results

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Query Parameters

from*string

Inclusive lower bound of the analysis window, as a UTC calendar day in YYYY-MM-DD format.

to*string

Inclusive upper bound of the analysis window, as a UTC calendar day in YYYY-MM-DD format.

deviceType?string

Filter funnel analytics to a specific device type. Defaults to ALL.

attributionType?string

Attribution type for UTM filter matching in funnel steps.

utmSource?string

Filter by UTM source.

utmMedium?string

Filter by UTM medium.

utmCampaign?string

Filter by UTM campaign.

utmContent?string

Filter by UTM content.

utmTerm?string

Filter by UTM term.

utmName?string

Filter by UTM name.

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"
{
  "steps": [
    {
      "stepNumber": 0,
      "visitorCount": 0,
      "conversionCount": 0,
      "conversionRate": 0,
      "dropOffRate": 0,
      "overallConversionRate": 0,
      "avgTimeToNextStep": 0,
      "sessionIds": [
        "string"
      ],
      "dropOffSessionIds": [
        "string"
      ]
    }
  ],
  "totalVisitors": 0,
  "overallConversionRate": 0,
  "overallAvgTimeToConversion": 0
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}
{
  "error": "string",
  "details": "string"
}

How is this guide?

Attribution (Beta)

Previous Page

Heatmaps

Next Page