This is an archive version of the document. To get the most up-to-date information, see the current version.Viewing License Usage Report
You can get a resource representation of a license usage report.
Request
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 resource representation of the /licensing/reports/latest resource. The resource body contains the following properties:
Property | Type | Description |
|---|---|---|
reportParameters | Information about the report and Veeam Backup for Microsoft 365 license. | |
reportSummary | Summary information about license consumption. | |
organizations | Information about license consumption for each organization added to Veeam Backup for Microsoft 365. |
Property | Type | Description |
|---|---|---|
reportId | integer | Identification number of the report. |
reportStatus | string | Status of the report. The following values are available:
|
companyName | string | Name of the company to which the license was issued. |
licenseId | string | Identification number of the license. |
licenseExpirationDate | UTC | Date and time when the license will expire. |
supportId | string | Support ID of the installed license. |
reportGenerationDate | UTC | Date and time when the report was generated. |
reportingInterval | object | Start and end date that define the time period covered by the report. |
Property | Type | Description |
|---|---|---|
initialUsersCount | integer | Number of users that consume the license within the time period covered by the report. |
reportedUsersCount | integer | Number of users consuming the license that you report to Veeam. |
newUsersCount | integer | Number of users that started consuming the license within the time period covered by the report. |
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 | integer | Number of organization users removed from the report. |
removalReason | string | Reason for removal of a user from the report. |
reportedUsersCount | integer | Number of organization users consuming the license that you report to Veeam. |
newUsersCount | integer | Number of organization users that started consuming the license within the time period covered by the report. |
initialUsersCount | integer | Number of organization users that consume the license within the time period covered by the report. |
The example returns a resource representation of the license usage report.
Request: GET https://abc.tech.local:4443/v6/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:00Z", "supportId": "00000000", "reportGenerationDate": "2020-12-01T17:07:14.7924236Z", "reportingInterval": { "startOfInterval": "2020-11-01T00:00:00Z", "endOfInterval": "2020-11-30T00:00:00Z" } }, "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 } ] } |
