ReportApi.md

ReportApi

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

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

reportCreate

ReportCreateResponse reportCreate(reportCreateRequest)

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.

Example

import com.dropbox.sign.ApiException;
import com.dropbox.sign.Configuration;
import com.dropbox.sign.api.*;
import com.dropbox.sign.auth.*;
import com.dropbox.sign.model.*;

import java.util.List;

public class Example {
    public static void main(String[] args) {
        var apiClient = Configuration.getDefaultApiClient()
            .setApiKey("YOUR_API_KEY");

        // or, configure Bearer (JWT) authorization: oauth2
        /*
        var apiClient = Configuration.getDefaultApiClient()
            .setBearerToken("YOUR_ACCESS_TOKEN");
        */

        var reportApi = new ReportApi(apiClient);

        var data = new ReportCreateRequest()
            .startDate("09/01/2020")
            .endDate("09/01/2020")
            .reportType(List.of(
                ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY,
                ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS
            ));

        try {
            ReportCreateResponse result = reportApi.reportCreate(data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountCreate");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
reportCreateRequest	ReportCreateRequest

Return type

ReportCreateResponse

Authorization

api_key

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-