Generating Data Protection Reports

In this article

    You can generate data protection reports, such as license overview, mailbox protection and storage consumption reports.

    Request

    POST https://<hostname>:4443/v5/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 License Overview Report

    To generate the 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:

    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

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

    format

    string

    Specifies the type of the format for the generated report:

    • PDF
    • CSV

    For example:

    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

    To generate the 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:

    Request Body:

    {

      "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.

    Examples

    Example 1

    The example shows how to generate the Mailbox Protection report.

    Request:

    POST https://abc.tech.local:4443/v5/Reports/action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

    "generate": {

      "type":  "mailboxProtection",

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

      "format": "pdf"

     }

    }

     

    Response:

    200 OK