This is an archive version of the document. To get the most up-to-date information, see the current version.Generating Data Protection Reports
You can generate data protection reports, such as license overview, mailbox protection and storage consumption reports.
Request
Request Headers
The request header must contain an authorization token of the current session.
Request Body
The /Reports/action resource can contain different properties depending on the type of the report:
Generate License Overview Report
Property | Type | Description |
|---|---|---|
type | string | Specifies the type of a report. |
startTime | string | Specifies a beginning time of the reporting interval. |
endTime | string | Specifies an ending time of the reporting interval. |
format | string | Specifies the format in which to save a report:
|
Request Body: { "generate": { "type": "licenseOverview", "startTime": "2018.10.04 15:25:00", "endTime": "2018.11.17 12:30:00", "format": "pdf" } } |
Generate Storage Consumption Report
Property | Type | Description |
|---|---|---|
type | string | Specifies the type of a report. |
startTime | string | Specifies a beginning time of the reporting interval. |
endTime | string | Specifies an ending time of the reporting interval. |
format | string | Specifies the type of the format for the generated report:
|
Request Body: { "generate": { "type": "storageConsumption", "startTime": "2018.10.04 15:25:00", "endTime": "2018.11.17 12:30:00", "format": "pdf" } } |
Generate Mailbox Protection Report
Property | Type | Description |
|---|---|---|
type | string | Specifies the type of a report. |
organizationId | string | Specifies an ID of an organization for which the protected user mailboxes report will be generated. |
format | string | Specifies the type of the format for the generated report:
|
Request Body: { "generate": { "type": "mailboxProtection", "organizationId": "d6ce571c-c583-466e-bbcc-5bb5078fa6b9", "format": "pdf" } } |
The server returns the following response to the client.
A successfully completed operation returns a response code 200 OK.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
The example shows how to generate the Mailbox Protection report.
