EaserixDocs
DevelopersAPI referenceSignEngagement

Completion rate and time over a date range

Every sent document the caller can see, optionally narrowed to a sent_at date range (from/to — RFC3339 or YYYY-MM-DD), with a summary (sentCount, completedCount, completionRate, avgCompletionSeconds) computed over the FULL filtered cohort plus the underlying documents for drill-down. completionRate is null (not 0) when sentCount is 0 — an empty period must never render as "0% completion". The cohort is always "documents sent in this window" for both the numerator and denominator; it is never silently swapped to "documents completed in this window" under a different sent_at filter.

View as Markdown
GET
/v1/documents/completion-stats
AuthorizationBearer <token>

In: header

Query Parameters

from?string

Start of the sent_at range (inclusive). RFC3339 or YYYY-MM-DD.

to?string

End of the sent_at range (inclusive). RFC3339 or YYYY-MM-DD. A bare YYYY-MM-DD date includes the entire day — e.g. to=2026-09-17 covers everything sent through 2026-09-17T23:59:59.999999999, not just up to midnight at the start of that day. An explicit RFC3339 timestamp with a time component is used exactly as given.

limit?integer

Page size for the documents drill-down list. Default 10, capped at 100.

offset?integer

Page start for the documents drill-down list. Default 0.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/documents/completion-stats"
{  "summary": {    "sentCount": 0,    "completedCount": 0,    "completionRate": 0,    "avgCompletionSeconds": 0  },  "documents": [    {      "id": "string",      "name": "string",      "status": "string",      "sentAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "completionSeconds": 0    }  ],  "total": 0,  "limit": 0,  "offset": 0,  "from": "2019-08-24T14:15:22Z",  "to": "2019-08-24T14:15:22Z"}