Documents

Get document logs

Get a detailed log of events for a document. On a rejected row, event_meta_data is the reason the recipient gave when rejecting the document, or an empty string when no reason was given.

get/v1/documents/{documentId}/log

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/documents/{documentId}/log
  • Auth: HTTP bearer

Path parameters

documentIdstring required

Id of the document.

Response

The request succeeded.

document_idstring required

Id of the document the row belongs to.

first_namestring required

First name of the person the row belongs to.

last_namestring required

Last name of the person the row belongs to.

emailstring required

Email address of the person the row belongs to.

event_namestring required

What happened: an event log name such as sent, viewed, verified, signed or rejected; emailopened, videoplayed, clicked or attachmentopened for tracked activity; an email bounce status such as hardbounced or softbounced; or sms, video or reminder for a reminder.

event_meta_datastring required

Extra data of the row. On most event log rows it is the device type: desktop, smartphone, tablet or empty. A verified row holds the verification method, such as biometric or sms; a commented row the comment; a rejected row the reason the recipient gave. A videoplayed row holds the watch time, such as 12.5 s.; emailopened the email client details; an email bounce the bounce reason; clicked the value of the clicked field; attachmentopened the attachment title. Empty otherwise.

geo_ipstring required

IP address the action came from.

geo_citystring required

City the IP address resolved to.

geo_country_namestring required

Country the IP address resolved to.

created_atstring required

When the action happened.

Changes

No recorded changes to this operation across all 1 revision of this API.