Skip to content

Get Webchat Visitor Funnel

GET
/webchat/visitors/funnel

Engagement funnel for the widget: per-event counts, top pages, denominators.

abandonment_window_minutes IS NOT YET APPLIED by the app: it is validated and echoed back, but no number in the response depends on it. Do not build on it expecting the figures to move. answer_feedback and conversation_abandoned are declared stages the app does not yet produce, so they are absent rather than zero.

Authorizations

Parameters

Query Parameters

bot_id
Any of:
string
<= 64 characters
page_url
Any of:
string
<= 2048 characters
date_from
Any of:
string

ISO date, inclusive.

date_to
Any of:
string

ISO date, inclusive.

abandonment_window_minutes

Validated and echoed back; not yet applied to any figure.

integer
default: 30 >= 5 <= 1440

Validated and echoed back; not yet applied to any figure.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one webchat object.

Open because the widget’s config grows a field per product decision and a pinned schema would DROP it. Same choice the desk surface made.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string