latestOpenAPI 3.0.12026-08-21183382785.0 KB

24caa8eb809b

Funnels

Retrieve the population statistics of a funnel and its funnel stages

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

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

Path parameters

audienceIdinteger required

Audience ID of the funnel

funnelIdinteger required

ID of funnel to return

Query parameters

fromstring date
Example:2019-01-01

from date

tostring date
Example:2019-04-30

to date (inclusive)

limitinteger

number of days to fetch funnel statistics

Response

array of tuple of statistics

populationinteger nullable

the latest population of the funnel

Example response

{
  "population": 1000,
  "stages": [
    {
      "id": 44242,
      "history": [
        [
          1600297704,
          362,
          true
        ],
        [
          1600383964,
          362,
          true
        ]
      ]
    },
    {
      "id": 44240,
      "history": [
        [
          1600297667,
          122,
          true
        ],
        [
          1600383950,
          122,
          true
        ]
      ]
    },
    {
      "id": 44241,
      "history": [
        [
          1600297690,
          516,
          true
        ],
        [
          1600383956,
          516,
          true
        ]
      ]
    }
  ]
}