ReportApi.md

Dropbox\Sign\ReportApi

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

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

reportCreate()

reportCreate($report_create_request): \Dropbox\Sign\Model\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.

Example

<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

$reportApi = new Dropbox\Sign\Api\ReportApi($config);

$data = new Dropbox\Sign\Model\ReportCreateRequest();
$data->setStartDate("09/01/2020")
    ->setEndDate("09/01/2020")
    ->setReportType([
        Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_USER_ACTIVITY,
        Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_DOCUMENT_STATUS,
    ]);

try {
    $result = $reportApi->reportCreate($data);
    print_r($result);
} catch (Dropbox\Sign\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling Dropbox Sign API: "
        . print_r($error->getError());
}

Parameters

Name	Type	Description	Notes
report_create_request	\Dropbox\Sign\Model\ReportCreateRequest

Return type

\Dropbox\Sign\Model\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]