Skip to main content
GET
/
funnels
Get Funnel Analysis
curl --request GET \
  --url https://ebn.telemetree.io/public-api/funnels \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "avgTransTimes": [
      0
    ],
    "cumulative": [],
    "cumulativeRaw": [],
    "dayAvgTransTimes": {
      "formattedXValues": [
        "Aug 01",
        "Aug 02",
        "Aug 03"
      ],
      "series": [],
      "xValues": [
        "2024-08-01",
        "2024-08-02",
        "2024-08-03"
      ]
    },
    "dayFunnels": {
      "formattedXValues": [
        "Aug 01",
        "Aug 02",
        "Aug 03"
      ],
      "series": [],
      "xValues": [
        "2024-08-01",
        "2024-08-02",
        "2024-08-03"
      ]
    },
    "dayMedianTransTimes": {
      "formattedXValues": [
        "Aug 01",
        "Aug 02",
        "Aug 03"
      ],
      "series": [],
      "xValues": [
        "2024-08-01",
        "2024-08-02",
        "2024-08-03"
      ]
    },
    "events": [
      "Pageview /",
      "Wallet"
    ],
    "filters": [
      {
        "op": "is",
        "prop": "country",
        "values": [
          "United States"
        ]
      }
    ],
    "groupBy": [
      "is_premium"
    ],
    "groups": {
      "0": {
        "avgTransTimes": [
          0,
          31675
        ],
        "cumulative": [
          2
        ],
        "cumulativeRaw": [
          2
        ],
        "dayAvgTransTimes": {
          "formattedXValues": [],
          "series": [
            [
              0
            ],
            [
              0,
              194
            ]
          ],
          "xValues": []
        },
        "dayFunnels": {
          "formattedXValues": [],
          "series": [
            [
              0
            ],
            [
              1
            ]
          ],
          "xValues": []
        },
        "dayMedianTransTimes": {
          "formattedXValues": [],
          "series": [
            [
              0
            ],
            [
              0,
              194
            ]
          ],
          "xValues": []
        },
        "medianTransTimes": [
          0,
          280
        ],
        "stepByStep": [
          2
        ]
      },
      "1": {
        "avgTransTimes": [
          0,
          63
        ],
        "cumulative": [
          1
        ],
        "cumulativeRaw": [
          1
        ],
        "dayAvgTransTimes": {
          "formattedXValues": [],
          "series": [
            [
              0,
              63
            ]
          ],
          "xValues": []
        },
        "dayFunnels": {
          "formattedXValues": [],
          "series": [
            [
              1
            ]
          ],
          "xValues": []
        },
        "dayMedianTransTimes": {
          "formattedXValues": [],
          "series": [
            [
              0,
              34
            ]
          ],
          "xValues": []
        },
        "medianTransTimes": [
          0,
          34
        ],
        "stepByStep": [
          1
        ]
      }
    },
    "medianTransTimes": [
      0
    ],
    "stepByStep": []
  }
}

Authorizations

​
x-api-key
string
header
required

Your API Key (Dashboard->Settings)

Query Parameters

​
events
string[]
required

List of events to analyze (at least 2 events are required)

​
group_by
enum<string>[] | null

List of fields to group by

​
start
string
required

Start date in YYYYMMDD format

​
end
string
required

End date in YYYYMMDD format

​
segments
string[] | null

Segments in Amplitude-like format. Example used: [{"prop":"country","op":"is","values":["United States"]}]

Response

Successful Response

​
data
FunnelAnalysisData · object[]
required
Maximum length: 1
Example:
{
  "avgTransTimes": [0],
  "cumulative": [],
  "cumulativeRaw": [],
  "dayAvgTransTimes": {
    "formattedXValues": ["Aug 01", "Aug 02", "Aug 03"],
    "series": [],
    "xValues": ["2024-08-01", "2024-08-02", "2024-08-03"]
  },
  "dayFunnels": {
    "formattedXValues": ["Aug 01", "Aug 02", "Aug 03"],
    "series": [],
    "xValues": ["2024-08-01", "2024-08-02", "2024-08-03"]
  },
  "dayMedianTransTimes": {
    "formattedXValues": ["Aug 01", "Aug 02", "Aug 03"],
    "series": [],
    "xValues": ["2024-08-01", "2024-08-02", "2024-08-03"]
  },
  "events": ["Pageview /", "Wallet"],
  "filters": [
    {
      "op": "is",
      "prop": "country",
      "values": ["United States"]
    }
  ],
  "groupBy": ["is_premium"],
  "groups": {
    "0": {
      "avgTransTimes": [0, 31675],
      "cumulative": [2],
      "cumulativeRaw": [2],
      "dayAvgTransTimes": {
        "formattedXValues": [],
        "series": [[0], [0, 194]],
        "xValues": []
      },
      "dayFunnels": {
        "formattedXValues": [],
        "series": [[0], [1]],
        "xValues": []
      },
      "dayMedianTransTimes": {
        "formattedXValues": [],
        "series": [[0], [0, 194]],
        "xValues": []
      },
      "medianTransTimes": [0, 280],
      "stepByStep": [2]
    },
    "1": {
      "avgTransTimes": [0, 63],
      "cumulative": [1],
      "cumulativeRaw": [1],
      "dayAvgTransTimes": {
        "formattedXValues": [],
        "series": [[0, 63]],
        "xValues": []
      },
      "dayFunnels": {
        "formattedXValues": [],
        "series": [[1]],
        "xValues": []
      },
      "dayMedianTransTimes": {
        "formattedXValues": [],
        "series": [[0, 34]],
        "xValues": []
      },
      "medianTransTimes": [0, 34],
      "stepByStep": [1]
    }
  },
  "medianTransTimes": [0],
  "stepByStep": []
}
⌘I