Skip to content

Latest commit

 

History

History
81 lines (51 loc) · 2.34 KB

ReportApi.md

File metadata and controls

81 lines (51 loc) · 2.34 KB

dropbox_sign.ReportApi

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

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

report_create

ReportCreateResponse report_create(report_create_request)

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

  • Basic Authentication (api_key):
from pprint import pprint

from dropbox_sign import \
    ApiClient, ApiException, Configuration, apis, models

configuration = Configuration(
    # Configure HTTP basic authorization: api_key
    username="YOUR_API_KEY",

    # or, configure Bearer (JWT) authorization: oauth2
    # access_token="YOUR_ACCESS_TOKEN",
)

with ApiClient(configuration) as api_client:
    report_api = apis.ReportApi(api_client)

    data = models.ReportCreateRequest(
        start_date="09/01/2020",
        end_date="09/01/2020",
        report_type=["user_activity" "document_status"],
    )

    try:
        response = report_api.report_create(data)
        pprint(response)
    except ApiException as e:
        print("Exception when calling Dropbox Sign API: %s\n" % e)

Parameters

Name Type Description Notes
report_create_request 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 -

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