forms

Embed
Preview of the card
<a href="https://lucida.15-204-158-166.sslip.io/docs/ref-forms"><img src="https://lucida.15-204-158-166.sslip.io/docs/_api/public/orgs/af34862a-c837-4478-8335-0505efe40459/spaces/da916cd3-c0fc-4b63-b971-b3c13623daf3/pages/132352ad-b604-44c5-89b9-6a15e4a34103/social-card.svg?v=3e7ae33eec8b" alt="forms" width="600" height="315"></a>
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/forms

Parameters

project_idstringpathrequired
urlstringquery
formstringquery
fromstringquery
tostringquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/forms"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "drop_off_field": "string",
  "fields": [
    {
      "abandons": 0,
      "avg_time_ms": 0,
      "errors": 0,
      "field": "string",
      "refills": 0,
      "sessions": 0
    }
  ],
  "forms": [
    {
      "abandons": 0,
      "completion_rate": 0,
      "form": "string",
      "starts": 0,
      "submits": 0
    }
  ]
}
Schema
drop_off_fieldstringrequired
fieldsFieldRow[]required
Show child parameters
abandonsintegerrequired
avg_time_msnumberrequired
errorsintegerrequired
fieldstringrequired
A hash of the field name; never a value.
refillsintegerrequired
sessionsintegerrequired
formsFormRow[]required
Show child parameters
abandonsintegerrequired
completion_ratenumberrequired
formstringrequired
startsintegerrequired
submitsintegerrequired
400
404
503
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/forms/abandonment-reasons

Parameters

project_idstringpathrequired
fromstringquery
tostringquery
limitintegerquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/forms/abandonment-reasons"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Reasons by abandon count, descending
400
404
503
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/frustration

Parameters

project_idstringpathrequired
fromstringquery
tostringquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/frustration"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 rage/dead/frustration signals
Example
{
  "by_element": [
    {
      "page": "string",
      "selector": "string",
      "sessions": 0,
      "signals": 0
    }
  ],
  "by_page": [
    {
      "page": "string",
      "sessions": 0,
      "signals": 0
    }
  ],
  "trend": [
    {
      "day": "string",
      "kind": "string",
      "sessions": 0,
      "signals": 0
    }
  ]
}
Schema
by_elementFrustrationElement[]required
Show child parameters
pagestringrequired
selectorstringrequired
sessionsintegerrequired
signalsintegerrequired
by_pageFrustrationPage[]required
Show child parameters
pagestringrequired
sessionsintegerrequired
signalsintegerrequired
trendFrustrationDay[]required
Show child parameters
daystringrequired
YYYY-MM-DD
kindstringrequired
sessionsintegerrequired
signalsintegerrequired
400
404
503
Updated