Skip to content
API docs
Sign inOpen app

Concepts

Response states

A response is saved while the person answers, so every response is finished, started or left.

The three states

You can tell the state from status and leftAt.

  • Finished means status is complete. The person reached an ending, which submitted the response.
  • Started means status is partial and leftAt is null. The person may still be answering.
  • Left means status is partial and leftAt is set. The person closed the page or did nothing for 5 minutes. If they come back and continue, leftAt is cleared.

To filter GET /v1/submissions by state, pass state as finished, started or left. Passing status as partial gets started and left responses together.

Endings and leads

Every path through a form stops at an ending, such as "Order placed". Each ending says whether it counts as a lead in countsAsLead. A response that reached an ending that doesn't count is a disqualified one. GET /v1/submissions/endings lists the endings a form's responses reached, including ones deleted from the form since.

Earlier unfinished responses

When the same email or phone left an unfinished response on the same form within 30 days, earlierSubmissionId links to it. It's only a link, and neither response is changed.