Dropbox Report API

openapi: 3.2.0
info:
  title: Reference Report API
  version: 1.0.0
servers:
- url: https://api.hellosign.com/v3
  description: https://api.hellosign.com/v3
tags:
- name: Report
paths:
  /report/create:
    post:
      operationId: report_create
      summary: Create Report
      description: '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.'
      tags:
      - Report
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportCreateResponse'
        '400':
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportCreateRequest'
      security:
      - Basic: []
components:
  schemas:
    ReportResponse:
      type: object
      properties:
        success:
          type: string
          description: A message indicating the requested operation's success
        start_date:
          type: string
          description: The (inclusive) start date for the report data in MM/DD/YYYY format.
        end_date:
          type: string
          description: The (inclusive) end date for the report data in MM/DD/YYYY format.
        report_type:
          type: array
          items:
            $ref: '#/components/schemas/ReportResponseReportTypeItems'
          description: The type(s) of the report you are requesting. Allowed values are "user_activity" and "document_status". User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).
      description: Contains information about the report request.
      title: ReportResponse
    ReportCreateResponse:
      type: object
      properties:
        report:
          $ref: '#/components/schemas/ReportResponse'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/WarningResponse'
          description: A list of warnings.
      required:
      - report
      title: ReportCreateResponse
    ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponseError'
      required:
      - error
      title: ErrorResponse
    ErrorResponseError:
      type: object
      properties:
        error_msg:
          type: string
          description: Message describing an error.
        error_path:
          type: string
          description: Path at which an error occurred.
        error_name:
          type: string
          description: Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance.
      required:
      - error_msg
      - error_name
      description: Contains information about an error that occurred.
      title: ErrorResponseError
    ReportResponseReportTypeItems:
      type: string
      enum:
      - user_activity
      - document_status
      - sms_activity
      - fax_usage
      title: ReportResponseReportTypeItems
    WarningResponse:
      type: object
      properties:
        warning_msg:
          type: string
          description: Warning message
        warning_name:
          type: string
          description: Warning name
      required:
      - warning_msg
      - warning_name
      description: A list of warnings.
      title: WarningResponse
    ReportCreateRequest:
      type: object
      properties:
        end_date:
          type: string
          description: The (inclusive) end date for the report data in `MM/DD/YYYY` format.
        report_type:
          type: array
          items:
            $ref: '#/components/schemas/ReportCreateRequestReportTypeItems'
          description: The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).
        start_date:
          type: string
          description: The (inclusive) start date for the report data in `MM/DD/YYYY` format.
      required:
      - end_date
      - report_type
      - start_date
      title: ReportCreateRequest
    ReportCreateRequestReportTypeItems:
      type: string
      enum:
      - user_activity
      - document_status
      - sms_activity
      - fax_usage
      title: ReportCreateRequestReportTypeItems
  securitySchemes:
    Basic:
      type: http
      scheme: basic
      description: "Use your API key with HTTP Basic authentication in the form `Basic <api_key>`. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n"
    Bearer:
      type: http
      scheme: bearer
      description: "You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information.\n  ❌ **Not supported** by Try it console.\n"
x-provenance:
  method: harvested
  publisher: Dropbox
  source: https://developers.hellosign.com/openapi/api-reference.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)