Create funnel (legacy)

Request

Create a new funnel, assign it a name and description matching your business needs.

This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative.

Security

TdApikeyAuth

Path

audienceIdinteger, (int64)required

Master Segment ID

Bodyapplication/jsonrequired

Funnel parameters to create

namestringrequired

name

descriptionstring

description

segmentFolderIdinteger, (int64)required

stagesArray of objects, [ 3 .. 8 ] itemsrequired

funnel stages

Example:

[
  {
    "name": "Awareness"
  },
  {
    "id": 1,
    "name": "Interest"
  },
  {
    "name": "Conversion"
  }
]

curl -i -X POST \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/funnels' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "segmentFolderId": 0,
    "stages": [
      {
        "name": "Awareness"
      },
      {
        "id": 1,
        "name": "Interest"
      },
      {
        "name": "Conversion"
      }
    ]
  }'

Responses

Succeeded to create funnel

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"
  }
}