latestOpenAPI 3.0.12026-08-21183382785.0 KB

24caa8eb809b

Funnels

Retrieve funnel by ID

Search and find a specific funnel by its identifier. <br> <br> <br>

get/audiences/{audienceId}/funnels/{funnelId}

Path parameters

audienceIdinteger required

Master Segment ID

funnelIdinteger required

Funnel ID

Response

succeeded to get

idstring integer

audienceIdstring integer

segmentFolderIdstring integer

namestring

populationinteger nullable

The latest population of the funnel

descriptionstring

numSyndicationsinteger

needToRunWorkflowboolean

true if need to run workflow to load data

createdAtstring date-time

updatedAtstring date-time

Example response

{
  "stages": [
    {
      "id": "1",
      "name": "Awareness",
      "numSyndication": 2,
      "audienceId": "1",
      "funnelId": "10",
      "segmentFolderId": "30",
      "segmentId": "999"
    },
    {
      "id": "2",
      "name": "Interest",
      "numSyndications": 0,
      "audienceId": "1",
      "funnelId": "10",
      "segmentFolderId": "30",
      "segmentId": ""
    },
    {
      "id": "3",
      "name": "Conversion",
      "numSyndications": 0,
      "audienceId": "1",
      "funnelId": "10",
      "segmentFolderId": "30",
      "segmentId": ""
    }
  ]
}