Viewing License Usage Report

This section explains how to get a resource representation of a license usage report.

Request

GET https://<hostname>:4443/v5/licensing/reports/latest

Request Headers

The request header must contain an authorization token of the current session.

Request Body

None.

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

In the response body, the server returns a representation of the /licensing/reports/latest resource. The resource body contains the following properties.

Property

Type

Description

reportParameters

reportParameters

Information about the report and Veeam Backup for Microsoft Office 365 license.

reportSummary

reportSummary

Summary information about license consumption.

organizations

organizations

Information about license consumption for each organization added to Veeam Backup for Microsoft Office 365.

Report Parameters

Property

Type

Description

reportId

int

Identification number of the report.

reportStatus

string

Status of the report. Possible values:

  • Draft — the report was not sent to Veeam.
  • Approved — the report was sent to Veeam.

companyName

string

Name of the company to which the license was issued.

licenseExpirationDate

datetime

Date and time when the license will expire.

supportId

string

Support ID of the installed license.

reportGenerationDate

datetime

Date and time when the report was generated.

reportingInterval

object

Start and end date that define the time period covered by the report.

Report Summary

Property

Type

Description

initialUsersCount

int

Number of users that consume the license at the time when the report is generated.

reportedUsersCount

int

Number of users consuming the license that you report to Veeam.

newUsersCount

int

Number of users that started consuming the license within the time period covered by the report.

Organization Statistics

Property

Type

Description

organizationId

string

Identification number of the organization whose license usage statistics is included in the report.

organizationName

string

Name of the organization whose license usage statistics is included in the report.

removedUserCount

int

Number of organization users removed from the report.

removalReason

string

Reason for removal of a user from the report.

reportedUsersCount

int

Number of organization users consuming the license that you report to Veeam.

newUsersCount

int

Number of organization users that started consuming the license within the time period covered by the report.

initialUsersCount

int

Number of organization users that consume the license at the time when the report is generated.

Example

The example below returns a representation of the license usage report.

Request:

GET https://abc.tech.local:4443/v5/licensing/reports/latest

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "reportParameters": {

   "reportID": 202011,

   "reportStatus": "Approved",

   "companyName": "ABC Company",

   "licenseExpirationDate": "2021-09-20T00:00:00",

   "supportID": "00000000",

   "reportGenerationDate": "2020-12-01T17:07:14.7924236Z",

   "reportingInterval": {

     "startOfInterval": "2020-11-01T00:00:00",

     "endOfInterval": "2020-11-30T00:00:00"

   }

 },

 "reportSummary": {

   "initialUsersCount": 3,

   "reportedUsersCount": 2,

   "newUsersCount": 0

 },

 "organizations": [

   {

     "organizationId": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000",

     "organizationName": "abc.onmicrosoft.com",

     "removedUsersCount": 1,

      "removalReason": "username:testuser@abc.onmicrosoft.com, reason:that was a test user",

     "reportedUsersCount": 2,

     "newUsersCount": 0,

     "initialUsersCount": 3

   }

 ]

}

I want to report a typo

There is a misspelling right here:

 

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