Retrieve funnel by ID

Request

Search and find a specific funnel by its identifier.

Security

TdApikeyAuth

Path

audienceIdinteger, (int64)required

Master Segment ID

funnelIdinteger, (int64)required

Funnel ID

curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/funnels/{funnelId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

succeeded to get

Bodyapplication/json

idstring, (integer)

audienceIdstring, (integer)

segmentFolderIdstring, (integer)

namestring

populationinteger or null, (int64)

The latest population of the funnel

descriptionstring

numSyndicationsinteger, (int64)

needToRunWorkflowboolean

true if need to run workflow to load data

stagesArray of objects, [ 3 .. 8 ] items

funnel stages

Example:

[
  {
    "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": ""
  }
]

createdAtstring, (date-time)

updatedAtstring, (date-time)

createdByobject(User)

updatedByobject(User)

Response

{
  "id": "string",
  "audienceId": "string",
  "segmentFolderId": "string",
  "name": "string",
  "population": 0,
  "description": "string",
  "numSyndications": 0,
  "needToRunWorkflow": true,
  "stages": [
    { … },
    { … },
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string",
    "td_user_id": "string",
    "name": "string"
  },
  "updatedBy": {
    "id": "string",
    "td_user_id": "string",
    "name": "string"
  }
}