Skip to content

ReportApi.md

Latest commit

 

History

History
71 lines (49 loc) · 1.95 KB

ReportApi.md

File metadata and controls

71 lines (49 loc) · 1.95 KB

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 fs from 'fs';
import api from "@dropbox/sign"
import models from "@dropbox/sign"

const apiCaller = new api.ReportApi();
apiCaller.username = "YOUR_API_KEY";

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

apiCaller.reportCreate(
  reportCreateRequest,
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling ReportApi#reportCreate:");
  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]