EaserixDocs
DevelopersAPI referenceSignEngagement

Per-recipient engagement detail for one document

First viewed, signed, time to sign, and who is currently blocking (sequential/parallel/group-aware, reusing the same turn-order logic the signing flow itself uses) — for one document. firstViewedAt is exactly that: the recipient's first open, since the platform never records a repeat view. timeToSignSeconds falls back to sentAt→signedAt when viewedAt is null (e.g. the owner signed this recipient in person), reported via timeToSignBasis ("fromView"|"fromSend") so the two are never silently mixed.

View as Markdown
GET
/v1/documents/{id}/engagement
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/documents/string/engagement"
{  "documentId": "string",  "status": "string",  "sentAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "completionSeconds": 0,  "recipients": [    {      "recipientId": "string",      "name": "string",      "email": "string",      "role": "string",      "isGroup": true,      "orderIndex": 0,      "status": "string",      "firstViewedAt": "2019-08-24T14:15:22Z",      "signedAt": "2019-08-24T14:15:22Z",      "timeToSignSeconds": 0,      "timeToSignBasis": "fromView",      "isBlocking": true,      "members": [        {          "name": "string",          "email": "string",          "viewedAt": "2019-08-24T14:15:22Z",          "declinedAt": "2019-08-24T14:15:22Z"        }      ]    }  ]}