API ReferenceReport

Create Report

View as Markdown

Request the creation of one or more report(s).

When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and start_date must not be more than 10 years in the past.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
end_datestringRequired

The (inclusive) end date for the report data in MM/DD/YYYY format.

report_typelist of enumsRequired

The type(s) of the report you are requesting. Allowed values are user_activity and document_status. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).

Allowed values:
start_datestringRequired

The (inclusive) start date for the report data in MM/DD/YYYY format.

Response headers

X-RateLimit-Limitinteger
The maximum number of requests per hour that you can make.
X-RateLimit-Remaininginteger
The number of requests remaining in the current rate limit window.
X-Ratelimit-Resetinteger
The Unix time at which the rate limit will reset to its maximum.

Response

successful operation
reportobject
Contains information about the report request.
warningslist of objects or null
A list of warnings.

Errors