A valid request URL is required to generate request examples{
"checklist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"audience": 123,
"audience_kind": "segment",
"completed": 123,
"steps": [
{
"step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"title": "<string>",
"kind": "event",
"position": 123,
"satisfied": 123,
"materialized": true
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Completion rate per step
Requires engagement:manage. The funnel: how many of the audience got past each step.
audience is the denominator — the segment’s members when the checklist has one, and otherwise every identified contact of the environment. Anonymous visitors are excluded on purpose: the widget mints one per page load, so counting them would put the whole funnel on your landing page’s traffic.
An entitlement step answers satisfied: null, never 0, and carries materialized: false. Nothing is stored for those — they are decided on the read against the team a request names — and a zero would read as “nobody holds the feature”, which is a number somebody would act on. completed is null for the same reason whenever the checklist carries one: a finish this side cannot see is not a finish it reports as absent.
A valid request URL is required to generate request examples{
"checklist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"audience": 123,
"audience_kind": "segment",
"completed": 123,
"steps": [
{
"step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"title": "<string>",
"kind": "event",
"position": 123,
"satisfied": 123,
"materialized": true
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Path Parameters
Response
The funnel.
Who the checklist is for: the segment's members, or every identified contact of the environment.
WHO this counts depends on the checklist: the segment for one you decide, and the people who CHOSE it for a selectable one. Read audience_kind rather than assuming — the segment is what a selectable list is offered to, and counting it there would report a list five people chose and three finished as 3% of a hundred.
Which population audience counted. segment for a checklist the tenant decides; choosers for a selectable one, where the people it is for are the ones who put it on their own guide.
segment, choosers How many finished the whole list. null when the checklist carries an entitlement step.
Show child attributes
Show child attributes