Reports

This section describes the following services related to reports:

This guide’s REST API chapter provides an overview of certain basic API calls. If you want to view all existing calls, see the REST API Object Model. Additional information about the calls can be found on the Developer Community website. That site’s Feature Guides may be especially helpful when you’re building your solution.

Retrieve a Usage Report on the Current Sender

GET /reports/usage

Description

Retrieve a Usage Report on the currently logged-in sender.

Resource Information

HTTP Method GET
Resource Family reports
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Optional Query Parameters

from Specify the date range from which records will be included in the report. Set the earliest date as from, and the latest date as to . If no dates are specified, the default value is the current day.
to

Example Request

GET https://sandbox.e-signlive.com/api/reports/usage?from=2014-12-10&to=2015-12-10

Retrieve a CSV Usage Report on the Current Sender

GET /reports/usage

Description

Retrieve into an CSV file a Usage Report on the currently logged-in sender.

Resource Information

HTTP Method GET
Resource Family reports
Authentication Authentication Tokens
Content-type application/json
Accept text/csv

Optional Query Parameters

from Specify the date range from which records will be included in the report. Set the earliest date as from, and the latest date as to . If no dates are specified, the default value is the current day.
to

Example Request

GET https://sandbox.e-signlive.com/api/reports/usage

Response Payload

"89ArAVjboS4S","account2@e-signlivetest.com","ESL","QA","483","160","299","500","9","9","40","500"

Retrieve a Completion Report on a Sender

GET /reports/completion

Description

Retrieve a Completion Report on a sender.

Resource Information

HTTP Method GET
Resource Family reports
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Optional Query Parameters

status Status of the package on which you want to search. Possible values are: draft, sent, completed, archived, declined, opted_out, trashed, and expired.
from Specify the date range from which records will be included in the report. Set the earliest date as from, and the latest date as to . If no dates are specified, the default value is the current day.
to
senderId The records in the report will all be associated with this sender ID. If no value is specified, the default senderId is the last sender in the account that created a package with the same state as that specified by status.

Example Request

GET https://sandbox.e-signlive.com/api/reports/completion?senderId=30d6c018-a790-475d-a5cd-0bdc3200a513&status=sent&from=2016-06-02&to=2016-06-09

Retrieve a CSV Completion Report on a Sender

GET /reports/completion

Description

Retrieve into an CSV file a Completion Report on a sender.

Resource Information

HTTP Method GET
Resource Family reports
Authentication Authentication Tokens
Content-type application/json
Accept text/csv

Optional Query Parameters

status Status of the package on which you want to search. Possible values are: draft, sent, completed, archived, declined, opted_out, trashed, and expired.
from Specify the date range from which records will be included in the report. Set the earliest date as from, and the latest date as to . If no dates are specified, the default value is the current day.
to
senderId The records in the report will all be associated with this sender ID. If no value is specified, the default senderId is the last sender in the account that created a package with the same state as that specified by status.

Example Request

GET https://sandbox.e-signlive.com/api/reports/completion?status=sent

Response Payload

sender