openapi: 3.0.0
info:
title: Dropbox API Reference Account Report API
description: "The powerful, yet simple, Dropbox API allows you to manage and control content and team settings programmatically and extend Dropbox capabilities in new and powerful ways. This is a collection that includes requests to all endpoints in the Dropbox API. \n\nThe Dropbox API is divided in two groups of endpoints: User Endpoints and Business Endpoints. Operations that would most likely be executed by a user, such as file operations, are in the User Endpoints folder. Operations that would most likely be executed by a team administrator, such as adding users to groups, live in the Business Endpoints folder. \n\nIf you are new to Dropbox Business and Team Administration, please have a look at the [Dropobox Admin Guide](https://help.dropbox.com/guide/admin/how-to-get-started#dropbox-admin-guide). \n\nIf you want more information on how to use our API please refer to our [Developer Portal](https://www.dropbox.com/developers). \n\n# What's in the collection?\n\nThe endpoints are organized in the following folders:\n* account\n* auth\n* check\n* contacts\n* file_properties\n* file_requests\n* files\n* sharing\n* team\n* team_log\n* users\n\n# Authorization\n\n## OAuth 2.0 for API Access\nDropbox uses OAuth 2.0, an open specification, to authorize access to data. To get an OAuth token from Dropbox to enable Postman to access your Dropbox account via the API you’ll need to create a new app on the DBX Platform.\n\n## Creating an App on the DBX Platform\nNavigate to https://www.dropbox.com/developers/apps and select “Create app” \n1. Choose an API \n2. Choose the type of access you need \n3. Give your app a name \n4. Choose the Dropbox account that will own your app \n\nFor reference, please use the [Dropbox OAuth guide](https://www.dropbox.com/lp/developers/reference/oauth-guide) \n\n## Generating an Access Token\nOnce you select “Create app” a page will load that displays information about your newly created app. To generate an access token scroll down to “OAuth 2” and click “Generate” beneath “Generated access token.” The token will display as a long string of characters. Copy this token for use with the Postman Collection.\n\n## Adding an Access Token to the requests\nIn the Postman client, click on the three dots to the right of the collection name to \"View more actions.\"\n\n\n\nThen, click \"Edit.\"\n\nClick on the \"Variables\" tab and, in the row for the `access_token` variable, paste your access token in the `CURRENT VALUE` column. The default value is `your-access-token-here`.\n\n\n\nFor information on sessions and variables in Postman see the blog post at https://blog.postman.com/sessions-faq/.\n\n# Notes\n* Dropbox also has a Postman Collection in the API Network to help administrators with team management workflows. It is called [Dropbox Team Admin Workflows](). \n\n"
version: 1.0.0
servers:
- url: https://api.dropbox.com
security:
- bearerAuth: []
tags:
- name: Report
description: _md__OpenApi::TAG::REPORT::DESCRIPTION
paths:
/report/create:
post:
tags:
- Report
summary: Dropbox _t__ReportCreate::SUMMARY
description: _t__ReportCreate::DESCRIPTION
operationId: reportCreate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReportCreateRequest'
examples:
default_example:
$ref: '#/components/examples/ReportCreateRequestDefaultExample'
responses:
'200':
description: successful operation
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/ReportCreateResponse'
examples:
default_example:
$ref: '#/components/examples/ReportCreateResponseExample'
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400ResponseExample'
401_example:
$ref: '#/components/examples/Error401ResponseExample'
402_example:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
- api_key: []
x-codeSamples:
- lang: PHP
label: PHP
source:
$ref: examples/ReportCreate.php
- lang: C#
label: C#
source:
$ref: examples/ReportCreate.cs
- lang: JavaScript
label: JavaScript
source:
$ref: examples/ReportCreate.js
- lang: TypeScript
label: TypeScript
source:
$ref: examples/ReportCreate.ts
- lang: Java
label: Java
source:
$ref: examples/ReportCreate.java
- lang: Ruby
label: Ruby
source:
$ref: examples/ReportCreate.rb
- lang: Python
label: Python
source:
$ref: examples/ReportCreate.py
- lang: cURL
label: cURL
source:
$ref: examples/ReportCreate.sh
x-meta:
seo:
title: _t__ReportCreate::SEO::TITLE
description: _t__ReportCreate::SEO::DESCRIPTION
components:
headers:
X-RateLimit-Remaining:
description: _t__Common::RateLimiting::REMAINING
schema:
type: integer
format: int32
example: 99
X-RateLimit-Limit:
description: _t__Common::RateLimiting::LIMIT
schema:
type: integer
format: int32
example: 100
X-Ratelimit-Reset:
description: _t__Common::RateLimiting::RESET
schema:
type: integer
format: int64
example: 1430170900
schemas:
ReportResponse:
description: _t__ReportResponse::DESCRIPTION
properties:
success:
description: _t__ReportResponse::SUCCESS
type: string
start_date:
description: _t__ReportResponse::START_DATE
type: string
end_date:
description: _t__ReportResponse::END_DATE
type: string
report_type:
description: _t__ReportResponse::REPORT_TYPE
type: array
items:
enum:
- user_activity
- document_status
type: object
x-internal: true
ErrorResponse:
required:
- error
properties:
error:
$ref: '#/components/schemas/ErrorResponseError'
type: object
ErrorResponseError:
description: _t__ErrorResponseError::DESCRIPTION
required:
- error_msg
- error_name
properties:
error_msg:
description: _t__ErrorResponseError::ERROR_MSG
type: string
error_path:
description: _t__ErrorResponseError::ERROR_PATH
type: string
error_name:
description: _t__ErrorResponseError::ERROR_NAME
type: string
type: object
WarningResponse:
description: _t__WarningResponse::LIST_DESCRIPTION
required:
- warning_msg
- warning_name
properties:
warning_msg:
description: _t__WarningResponse::WARNING_MSG
type: string
warning_name:
description: _t__WarningResponse::WARNING_NAME
type: string
type: object
ReportCreateResponse:
properties:
report:
$ref: '#/components/schemas/ReportResponse'
warnings:
description: _t__WarningResponse::LIST_DESCRIPTION
type: array
items:
$ref: '#/components/schemas/WarningResponse'
type: object
x-internal: true
ReportCreateRequest:
required:
- start_date
- end_date
- report_type
properties:
end_date:
description: _t__ReportCreate::END_DATE
type: string
report_type:
description: _t__ReportCreate::REPORT_TYPE
type: array
items:
type: string
enum:
- user_activity
- document_status
maxItems: 2
minItems: 1
start_date:
description: _t__ReportCreate::START_DATE
type: string
type: object
examples:
Error403ResponseExample:
summary: _t__Error::403
value:
$ref: examples/json/Error403ResponseExample.json
ReportCreateRequestDefaultExample:
summary: Default Example
value:
$ref: examples/json/ReportCreateRequestDefaultExample.json
Error402ResponseExample:
summary: _t__Error::402
value:
$ref: examples/json/Error402ResponseExample.json
ReportCreateResponseExample:
summary: _t__ReportCreateResponseExample::SUMMARY
value:
$ref: examples/json/ReportCreateResponseExample.json
Error400ResponseExample:
summary: _t__Error::400
value:
$ref: examples/json/Error400ResponseExample.json
Error4XXResponseExample:
summary: _t__Error::4XX
value:
$ref: examples/json/Error4XXResponseExample.json
Error401ResponseExample:
summary: _t__Error::401
value:
$ref: examples/json/Error401ResponseExample.json
securitySchemes:
bearerAuth:
type: http
scheme: bearer