Skip to main content
GET
Form performance and question summaries

Authorizations

Authorization
string
header
required

Your personal access token where supported, or a scoped API key (hc_…) created inside HueChat at Account → Developer API. Send it as Authorization: Bearer <token>.

Path Parameters

accountId
integer
required
Required range: x >= 1
formId
string<uuid>
required

Query Parameters

from
string<date>

Inclusive UTC day; defaults to all time.

to
string<date>

Inclusive UTC day; defaults to today.

device
enum<string>
Available options:
desktop,
mobile,
tablet,
other

Response

Performance, devices, drop-off, summaries and invitation journey

views
integer
starts
integer
submissions
integer
completion_rate
number

Percentage from 0 to 100

avg_completion_seconds
number
devices
object
activity
object[]
dropoff
object[]
summary
object[]
sources
object[]
invitation
object
metrics
object[]
csat
number

Percent of CSAT 4–5; omitted without eligible data.

nps
number

Percent promoters 9–10 minus detractors 0–6; omitted without eligible data.