Get form analytics
get_form_analyticsThe funnel of one form, computed by dForms exactly as its Results screen shows it: views, starts, submissions, completion rate, median time to complete, partials, bookings and the drop-off per question, each with its definition. These are the figures to report: no other rate is derived here, and null means no data, not zero. A question is named as written, so a [placeholder] in it stays as is: it counts every respondent, whose own values differ.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"form_id": "<form_id>"
},
"name": "get_form_analytics"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day, inclusive (YYYY-MM-DD, in time_zone) or epoch ms. | |
| from | No | First day (YYYY-MM-DD, in time_zone) or epoch ms. Omit for all time. | |
| form_id | Yes | The form id, from list_forms or get_form. | |
| time_zone | No | IANA zone the days are counted in, e.g. America/Bogota. Default: the workspace zone. An unknown zone is refused. | |
| workspace_id | No | The workspace this call acts in: an id from list_my_workspaces. Required for a person signed in with several workspaces and for staff of this deployment; optional with an API key or with only one workspace. | |
| include_daily | No | Also return one point per day: at most the most recent 366 days of the range (daily_truncated says when it was cut). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| daily | No | ||
| range | Yes | ||
| window | Yes | ||
| dropoff | Yes | ||
| form_id | Yes | ||
| metrics | Yes | ||
| warnings | No | What did not go exactly as sent, or what the user needs to know. | |
| workspace | Yes | The workspace this call acted in, to compare with the one the user means. | |
| definitions | Yes | ||
| daily_truncated | No | With include_daily: true when daily is at its 366-day cap and the range may hold earlier days (always for a range longer than 366 days). Narrow from and to to read them. |