Generating Data Protection Reports

This section explains how to generate data protection reports such as license overview, mailbox protection and storage consumption reports.

Request

POST https://<hostname>:4443/v4/Reports/Action

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 a License Overview Report

To generate a License Overview report on the Veeam Backup for Microsoft Office 365 server, the request body must contain the generate action properties:

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:

  • PDF
  • CSV

For example:

{

"generate": {

 "type": "licenseOverview",

 "startTime": "2018.10.04 15:25:00",

 "endTime": "2018.11.17 12:30:00",

 "format": "pdf"

 }

}

Generate a Storage Consumption Report

To generate a Storage Consumption report on the Veeam Backup for Microsoft Office 365 server, the request body must contain the generate action properties:

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 the reporting interval.

Format

string

Specifies the type of the format for the generated report:

  • PDF
  • CSV

For example:

{

"generate": {

 "type": "storageConsumption",

 "startTime": "2018.10.04 15:25:00",

 "endTime": "2018.11.17 12:30:00",

 "format": "pdf"

 }

}

Generate a Mailbox Protection Report

To generate a Mailbox Protection report on the user mailboxes protected by the Veeam Backup for Microsoft Office 365 server, the request body must contain the generate action properties:

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:

  • PDF
  • CSV

For example:

{

  "generate": {

  "type":  "mailboxProtection",

  "organizationId": "d6ce571c-c583-466e-bbcc-5bb5078fa6b9",

  "format": "pdf"

  }

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

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

Response Body

None.

Example

The example below shows how to generate a Mailbox Protection report.

Request:

POST https://abc.tech.local:4443/v4/Reports/Action

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

"generate": {

  "type":  "mailboxProtection",

  "organizationId": "d6ce571c-c583-466e-bbcc-5bb5078fa6b9",

  "format": "pdf"

 }

}

 

Response:

200 OK

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.