Create Report

post/report/create

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.

Securityapi_key
Request
Request Body schema: application/json
start_date
required
string

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

end_date
required
string

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

report_type
required
Array of strings [ 1 .. 2 ] items

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).

Items Enum: "user_activity" "document_status"
Responses
200

successful operation

4XX

failed_operation

Request samples
application/json
{
  • "start_date": "09/01/2020",
  • "end_date": "09/01/2020",
  • "report_type": [
    ]
}
Response samples
application/json
{
  • "report": {
    }
}