Retrieve the population statistics of a funnel and its funnel stages

Request

Retrieve the population history of a funnel. The history is returned per day and those days are calculated in the timezone of the audience.

Security

TdApikeyAuth

Path

audienceIdinteger, (int64)required

Audience ID of the funnel

funnelIdinteger, (int64)required

ID of funnel to return

Query

fromstring, (date)

from date

Example:from=2019-01-01

tostring, (date)

to date (inclusive)

Example:to=2019-04-30

limitinteger, (int64)

number of days to fetch funnel statistics

curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/funnels/{funnelId}/statistics?from=2019-01-01&to=2019-04-30&limit=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

array of tuple of statistics

Bodyapplication/json

populationinteger or null, (int64)

the latest population of the funnel

Example:1000

stagesArray of objects

Example:

[
  {
    "id": 44242,
    "history": [ … ]
  },
  {
    "id": 44240,
    "history": [ … ]
  },
  {
    "id": 44241,
    "history": [ … ]
  }
]

Response

{
  "population": 1000,
  "stages": [
    { … },
    { … },
    { … }
  ]
}