ReportApi.md

ReportApi

All URIs are relative to https://api.hellosign.com/v3.

Method	HTTP request	Description
reportCreate()	POST /report/create	Create Report

reportCreate()

reportCreate(reportCreateRequest: ReportCreateRequest): ReportCreateResponse

Create Report

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.

TypeScript Example

import * as DropboxSign from "@dropbox/sign";

const reportApi = new DropboxSign.ReportApi();

// Configure HTTP basic authorization: api_key
reportApi.username = "YOUR_API_KEY";

const data: DropboxSign.ReportCreateRequest = {
  startDate: "09/01/2020",
  endDate: "09/01/2020",
  reportType: [
    DropboxSign.ReportCreateRequest.ReportTypeEnum.UserActivity,
    DropboxSign.ReportCreateRequest.ReportTypeEnum.DocumentStatus,
  ]
};

const result = reportApi.reportCreate(data);
result.then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling Dropbox Sign API:");
  console.log(error.body);
});

JavaScript Example

import * as DropboxSign from "@dropbox/sign";

const reportApi = new DropboxSign.ReportApi();

// Configure HTTP basic authorization: api_key
reportApi.username = "YOUR_API_KEY";

const data = {
  startDate: "09/01/2020",
  endDate: "09/01/2020",
  reportType: [
    "user_activity",
    "document_status",
  ]
};

const result = reportApi.reportCreate(data);
result.then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling Dropbox Sign API:");
  console.log(error.body);
});

Parameters

Name	Type	Description	Notes
reportCreateRequest	ReportCreateRequest

Return type

ReportCreateResponse

Authorization

api_key

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]