Documentation · API reference
GET
/api/v1/sites/{site}/funnels/{id}A funnel across visits for visitors who agreed
This page as Markdown, or in an AI chatMore ways to read this page
A funnel across visits for visitors who agreed, and the same steps inside one visit for everyone. Never added.
# A funnel across visits for visitors who agreed
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-sites-site-funnels-id
`GET /api/v1/sites/{site}/funnels/{id}`
A funnel across visits for visitors who agreed, and the same steps inside one visit for everyone. Never added.
## Parameters
- `site` (in path, needed): A site's id or name
- `id` (in path, needed): The funnel
- `period` (in query): 30d when left out
- `by` (in query): source, country or device
## The answer
200, `FunnelReport`: A funnel across visits, for visitors who agreed (AN-01), and the same steps inside one visit for everyone (AN-05). The two answer different questions and are never added.
- `by` (string, needed): `source`, `country` or `device`: by what the visitor first came with.
- `coverage` (Coverage, needed)
- `easy` (list of integer, needed): The easy way: visits that reached each step inside one visit. Null for a day whose visits were counted before the funnel existed.
- `easy_says` (string, needed)
- `finished` (integer, needed)
- `finished_share` (number or null)
- `funnel` (FunnelView, needed)
- `in_one_visit` (integer, needed)
- `median_seconds` (integer or null): Median seconds from the first step to the last.
- `period` (PeriodView, needed)
- `site` (string, needed)
- `split` (list of FunnelSplit, needed)
- `steps` (list of FunnelStep, needed)
## Asking
```sh
curl https://tidekeeper.eu/api/v1/sites/example.org/funnels/{id} \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```
Parameters
- sitein the address
- neededA site's id or name
- idin the address
- neededThe funnel
- periodin the query
- 30d when left out
- byin the query
- source, country or device
The answer
Status 200
FunnelReport A funnel across visits, for visitors who agreed (AN-01), and the same steps inside one visit for everyone (AN-05). The two answer different questions and are never added.
- by
- stringneeded`source`, `country` or `device`: by what the visitor first came with.
- coverage
- Coverageneeded
- easy
- list of integerneededThe easy way: visits that reached each step inside one visit. Null for a day whose visits were counted before the funnel existed.
- easy_says
- stringneeded
- finished
- integerneeded
- finished_share
- number or null
- funnel
- FunnelViewneeded
- in_one_visit
- integerneeded
- median_seconds
- integer or nullMedian seconds from the first step to the last.
- period
- PeriodViewneeded
- site
- stringneeded
- split
- list of FunnelSplitneeded
- steps
- list of FunnelStepneeded
Asking
curl https://tidekeeper.eu/api/v1/sites/example.org/funnels/{id} \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/funnels/{id}", { headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, }, }).then((r) => r.json());