Skip to main content

Use cases

Calculate the endpoint usage with the Monthly License Usage report

This section explains how to calculate the endpoint usage with the Monthly License Usage report, in GravityZone Cloud.

As a Bitdefender managed service provider (MSP), you can offer Bitdefender cloud security add-ons and services in a flexible manner, best suited to your clients with monthly license. Consequently, you can charge them depending on how they use these products.

GravityZone helps you keep track of the used resources with the Monthly License Usage report, which you have to generate at the beginning of each month for the previous month.

For details about generating a Monthly License Usage report in Control Center or via API, refer to Create a Monthly License Usage report in GravityZone.

About the Monthly License Usage report

The Monthly License Usage report aims to provide all the details you need to measure and charge the usage of GravityZone services accordingly. It also includes information to simplify the process of billing.

Calculation of the monthly usage relies on the product type, protection model, add-ons and services that companies have used during the previous month.

Companies can use the following product types:

  • Endpoint Security - the fully-featured security solution, with all modules available for deployment on endpoints.

  • Bitdefender EDR - a lightweight Endpoint Detection and Response (EDR) solution for Windows-based systems that can run alongside any third-party protection platform.

When creating the report, you are provided with the following options that help you focus on the data you are interested in:

  • Product type - generate the report for either companies with Endpoint Security or with Bitdefender EDR.

  • Only endpoint details - the report focuses on information related to the endpoints and ignores the companies' hierarchy.

  • Only direct companies - the report does not include the entire hierarchy, but only child companies at the first level under the target company.

  • Only new customer companies - the report only includes companies created between two specific dates. When selected, these options appear below:

    • Company registration start date - only companies created after this start date will be included in the report.

    • Company registration end date - only companies created before this date will be included in the report.

    Important

    You must fill in both fields, otherwise no information will be included in the request.

As displayed in Control Center, the Monthly License Usage report consists mainly of two areas:

  • The chart, which depicts the usage of some GravityZone add-ons and services during the month.

  • The table, which lists details about companies, license and usage. The table is customizable by clicking the Show/Hide Columns button in the top-right corner.

    Clicking the numbers of each element of the column provides you with more details regarding endpoints and the usage of GravityZone add-ons and services.

Note

If a GravityZone add-on or service has not been enabled for a company, it is specified as such.

Below we have covered all the information covered in the report.

Note

Some columns can only be found in the .CSV version of the report.

Column name

Description

Path

The location of the target company in the network tree.

Company

The company's name.

Company type

The type of the company. Possible values:

  • Partner - companies that both use Bitdefender products and distribute them to other companies. They can also manage the security of other companies.

    Tip

    Partner companies are sometimes referred to as managing companies, or parents.

  • Customer - a company that is purchasing Bitdefender products directly from Bitdefender or through a partner, without reselling them to other companies. They can only manage their own security.

    Tip

    Customer companies are sometimes referred to as clients or children.

License key

The key of the license used by the company.

License Type

The type of the license. Possible values:

  • Monthly Subscription - the company purchases Bitdefender products from a partner company.

  • Monthly License - the company purchases Bitdefender products directly from Bitdefender and distributes it to other companies.

  • Monthly License Trial the company has received a trial subscription license from a partner company.

Month

The month for which the report was created.

Licensed endpoints

The number of endpoints licensed during the month (physical servers or workstations, virtual servers or workstations and container hosts).

Endpoint Usage

The number of endpoints with core protection.

A la carte Usage

The number of endpoints that register under Endpoint Usage under companies that use the A la carte protection model.

Secure Usage

The number of endpoints that register under Endpoint Usage under companies that use the Secure protection model.

Secure Plus Usage

The number of endpoints that register under Endpoint Usage under companies that use the Secure Plus protection model.

Secure Extra Usage

The number of endpoints that register under Endpoint Usage under companies that use the Secure Extra protection model.

Encryption Usage

The number of endpoints where the Full Disk Encryption add-on was deployed during the month.

Patch Management Usage

The number of endpoints where the Patch Management add-on was deployed during the month.

Integrity Monitoring Usage

The number of endpoints where the Integrity Monitoring add-on was deployed during the month.

Integrity Monitoring 90 Days Retention Usage

The number of endpoints where the Integrity Monitoring add-on and the 90 days data retention add-on was deployed during the month.

Integrity Monitoring 180 Days Retention Usage

The number of endpoints where the Integrity Monitoring add-on and the 180 days data retention add-on was deployed during the month.

Integrity Monitoring 1 Year Retention Usage

The number of endpoints where the Integrity Monitoring add-on and the 1 year data retention add-on was deployed during the month.

SVE: VS

The number endpoints that meet all the below requirements:

  • The company the endpoints belong to has the Security for Virtualized Environments feature enabled for own use.

  • The endpoint type is virtual and server.

  • The endpoint is connected to at least one Security Server (SVA).

  • The endpoint has the Central Scan scan mode enabled.

  • The endpoint has an operating system that is compatible with Central Scanning. Learn more

SVE: VDI (in hours)

The number of uptime hours for virtual desktops with Central Scan that meet the following requirements:

  • The company the endpoints belong to has the Security for Virtualized Environments feature enabled for own use.

  • The endpoint type is virtual and workstation.

  • The endpoint is connected to at least one Security Server (SVA).

  • The endpoint has the Central Scan scan mode enabled.

  • The endpoint has an operating system that is compatible with Central Scanning. Learn more

Container Protection Usage

The number of endpoints where the Container Protection add-on was deployed during the month.

ATS Usage

The number of endpoints where the Advanced Threat Security add-on (this includes both HyperDetect or Sandbox Analyzer) was enabled during the month.

EDR Usage

The number of endpoints where the Bitdefender EDR add-on was deployed during the month.

XDR Identity Providers Usage

The number of endpoints where the XDR sensor for Identity Providers was deployed.

XDR Productivity Usage

The number of endpoints where the XDR sensor for Productivity was deployed.

XDR Network Usage

The number of endpoints where the XDR sensor for Network was deployed.

XDR Cloud Workloads Usage

The number of endpoints where the XDR sensor for Cloud Workloads was deployed.

MDR Foundations Usage

The number of endpoints that belong to companies that use the Bitdefender MDR service, and are monitored.

Reserved Seats

The number of seats that have been reserved for the company.

Note

The table will show * if the option is not enabled for the company.

Subscription End Date

The end date for the company's license subscription.

Note

The table will show N/A if the option is not enabled for the company.

Subscription Auto-Renewal

Indicates if the Auto-Renewal option is enabled for the company.

Minimum Usage

Indicates if the Minimum Usage option is enabled for the company and displays the value assigned to it.

Product Type

The type of the product the company uses. Possible values:

  • Endpoint Protection

  • Bitdefender EDR

Available output formats

From the GravityZone Control Center, you can export the report in PDF and CSV formats, or you can send it through email.

Usage for companies with Endpoint Security

To calculate the monthly usage for GravityZone modules, add-ons, and services you need the CSV file.

The monthly usage is counted based on the enabled modules, add-ons, and services during the month. The modules are part of the GravityZone core protection, while add-ons and services are optional and billed separately.

Note

Depending on the protection model assigned to the company's own use, some add-ons and services may be included alongside the core protection. In these cases, the usage will show as 0 in monthly usage reports, regardless of the number of endpoints the associated models are deployed on.

If a company has used multiple protection models for its own use during a month, a single one counts toward its monthly usage. From the list of used protection models, the one matching the highest on this list is taken into account:

  1. Secure Extra

  2. Secure Plus

  3. Secure

  4. A la carte

The CSV file lists all the standard and optional security layers, along with other relevant data on companies and endpoints.

Usage for endpoints with core protection

The GravityZone core protection includes the following modules and roles:

  • Antimalware (not listed in the report as it is installed by default on endpoints)

  • Advanced Threat Control

  • Advanced Anti-Exploit

  • Firewall

  • Content Control

  • Device Control

  • Network Attack Defense

  • Power User

  • Relay

The usage for endpoints with standard protection is based on the Antimalware module.

The other modules do not generate additional usage in terms of billing, but they are listed in the CSV file for you to have a complete view over what is installed on the endpoints.

The usage is calculated based on the number of endpoints with core protection installed during the month and is available in the Endpoint Usage column.

A licensed endpoint does not qualify to be added under Endpoint Usage if any of the following conditions apply:

  • A Security Container package has been deployed on the endpoint during the month.

    Note

    In this case the endpoint usage will be recorded under Licensed Endpoints and Container Protection Usage.

  • All of the below conditions apply:

    • The company the endpoints belong to has the Security for Virtualized Environments feature enabled for own use.

    • The endpoint type is virtual.

    • The endpoint is connected to at least one Security Server (SVA).

    • The endpoint has the Central Scan scan mode enabled.

    • The endpoint has an operating system that is compatible with Central Scanning. Learn more

    Note

    In this case the endpoint usage will be recorded under Licensed Endpoints and SVE:VS or SVE:VDI.

API

Use the getMonthlyUsage method to obtain the value for endpointMonthlyUsage. For details, refer to getMonthlyUsage.

Usage for endpoints with add-ons

The GravityZone add-ons include:

Full Disk Encryption

The usage for Full Disk Encryption is calculated by the number of endpoints that have installed this add-on during the month.

In the CSV file of the Monthly License Usage report, filter the corresponding column by "Full Disk Encryption = Yes" to get the usage of this add-on.

API

Choose one of these variants:

  • Use the method getMonthlyUsage to obtain the value for encryptionMonthlyUsage.

  • Use the getMonthlyUsagePerProductType method to obtain the object usages with "productType": 0 and the value for encryptionMonthlyUsage.

Note

For details, refer to getMonthlyUsage and getMonthlyUsagePerProductType.

Patch Management

The usage of Patch Management is calculated by the number of endpoints that have used this add-on during the month.

In the CSV file of the Monthly License Usage report, filter the corresponding column by “Patch Management = Yes” to get the usage of this add-on.

API

Choose one of these variants:

  • Use the method getMonthlyUsage to obtain the value for patchManagementMonthlyUsage.

  • Use the getMonthlyUsagePerProductType method to obtain the object usages with "productType": 0 and the value for patchManagementMonthlyUsage.

Note

For details, refer to getMonthlyUsage and getMonthlyUsagePerProductType.

Advanced Threat Security (HyperDetect and Sandbox Analyzer)

The usage for Advanced Threat Security is calculated by the number of endpoints that have installed at least one of HyperDetect or Sandbox Analyzer add-ons during the month.

In the CSV file, filter the Advanced Threat Security by “ATS=Yes”.

If you want granular information, filter the HyperDetect and Sandbox Analyzer columns by "HyperDetect = Yes", then "Sandbox Analyzer = Yes". You have to combine the results to get the usage of these modules.

API

Choose one of these variants:

  • Use the method getMonthlyUsage to obtain the value for atsMonthlyUsage.

  • Use the getMonthlyUsagePerProductType method to obtain the object usages with "productType": 0 and the value for atsMonthlyUsage, which provides the usage for HyperDetect and Sandbox Analyzer.

Note

For details, refer to getMonthlyUsage and getMonthlyUsagePerProductType.

Endpoint Detection and Response

The usage for Endpoint Detection and Response (EDR) is calculated by the number of endpoints that have installed the EDR sensor during the month.

In the CSV file of the Monthly License Usage report, filter the corresponding column by “Endpoint Detection and Response = Yes” to get the usage of this module.

API

Choose one of these variants:

  • Use the method getMonthlyUsage to obtain the value for edrMonthlyUsage.

  • Use the getMonthlyUsagePerProductType method to obtain the object usages with "productType": 0 and the value for edrMonthlyUsage.

Note

For details, refer to getMonthlyUsage and getMonthlyUsagePerProductType.

eXtended Detection and Response (XDR)

Usage is calculated separately for each XDR category type (Identity Providers, Productivity, Network, and Cloud Workloads), based on three factors:

  • Having the XDR sensor category enabled.

  • The total number of endpoints licensed during the month.

  • Having at least one sensor deployed. If no sensors belonging to the category have been deployed at any point during the month, the usage is set to 0.

Note

Disabling all sensor types or reducing the total number of licensed endpoints will reflect in the following month's usage.

In the .CSV file of the Monthly License Usage report, the XDR Identity Providers, XDR Productivity, XDR Network, and XDR Cloud Workloads indicate which sensor types are enabled. You can get the usage for each sensor type by checking the values under the XDR Identity Providers Usage, XDR Productivity Usage, XDR Network Usage, and XDR Cloud Workloads Usage columns.

PHASR

The usage for PHASR is calculated by the number of manged endpoints for the company during this month.

In the CSV file of the Monthly License Usage report, filter the corresponding column by PHASR = Yes to get the usage of this add-on.

API

Choose one of these variants:

  • Use the method getMonthlyUsage to obtain the value for encryptionMonthlyUsage.

  • Use the getMonthlyUsagePerProductType method to obtain the object usages with "productType": 0 and the value for encryptionMonthlyUsage.

Note

For details, refer to getMonthlyUsage and getMonthlyUsagePerProductType.

Integrity Monitoring

The usage of Integrity Monitoring is calculated by the number of endpoints that have installed this add-on during the month.

Note

The monthly usage starts when the add-on is installed and licensed, not when it's enabled in the policy.

API

Choose one of these variants:

  • Use the getMonthlyUsage method to obtain the value applicable to you:

    • integrityMonitoringUsage - for the Integrity Monitoring base add-on.

    • integrityMonitoring90DaysUsage - for the Integrity Monitoring base add-on and the 90 days data retention add-on.

    • integrityMonitoring180DaysUsage - for the Integrity Monitoring base add-on and the 180 days data retention add-on.

    • integrityMonitoring1yearUsage - for the Integrity Monitoring base add-on and the 1 year data retention add-on.

  • Use the getMonthlyUsagePerProductType method to obtain the object usages with "productType": 0 and the value applicable to you:

    • integrityMonitoringUsage - for the Integrity Monitoring base add-on.

    • integrityMonitoring90DaysUsage - for the Integrity Monitoring base add-on and the 90 days data retention add-on.

    • integrityMonitoring180DaysUsage - for the Integrity Monitoring base add-on and the 180 days data retention add-on.

    • integrityMonitoring1yearUsage - for the Integrity Monitoring base add-on and the 1 year data retention add-on.

Note

For details, refer to getMonthlyUsage and getMonthlyUsagePerProductType.

If you upgrade your data retention add-on, you are going to be charged for the new add-on for the whole current month. However, if you downgrade your EDR retention add-on, you are going to be charged for the new add-on starting the first day of the following month.

If an endpoint is offline during a month when licensing changes occur, usage will be reported based on the add-on with the longest retention period that was active while it was online.

Security for Virtualized Environments

The usage for this add-on is calculated by:

  • Number of virtual servers with Security for Virtualized Environments

    Note

    Linux virtual machines are considered virtual servers.

  • Number of hours of using virtual workstations (VDI) with Security for Virtualized Environments

To obtain these data, you are provided with the following columns in the CSV file of the Monthly License Usage report:

  • Endpoint OS type: server or workstation.

  • Endpoint type: physical or virtual.

  • Uptime: how much time the endpoint has been protected by GravityZone. The uptime is counted in seconds and it is rounded up when converted in hours. For example, if the uptime for an endpoint with Central Scan is 3,600 seconds it means the endpoint will be charged for one hour. If the uptime is 3,650 seconds, the endpoint will be charged for two hours.

    Important

    The sleep and hibernation modes are not counted for uptime.

  • Security for Virtualized Environments: Yes means the endpoint used Central Scan engine at least once during the month. No means the company has been using Local Scan or Hybrid Scan engines.

In the CSV file, filter the columns as follows:

  1. For virtual servers (VS) with Security for Virtualized Environments by selecting "Security for Virtualized Environments = Yes" and "Endpoint type= Virtual" and "OS type = Server"

  2. For virtual workstations (VDI) with Security for Virtualized Environments by selecting "Security for Virtualized Environments = Yes" and "Endpoint type= Virtual" and "OS type = Workstation", then sum up the uptime and divide it by 3600 to get the hourly usage. The result is rounded up.

    Note

    In case of using virtual servers (VS) or virtual workstations (VDI), you need to subtract them from the total number of machines to avoid double billing.

API

Choose one of these variants:

  • Use the getMonthlyUsage method to obtain the value for:

    • sveVsMonthlyUsage, which provides the usage for virtual servers (VS) scanned with Security Server (Central Scan).

    • sveVdiMonthlyUsage, which provides the usage (in hours) for virtual desktops scanned with Security Server (Central Scan).

Note

For details, refer to getMonthlyUsage and getMonthlyUsagePerProductType.

Security for Exchange

The usage of Security for Exchange is calculated with the dedicated [Exchange] Monthly License Usage report. This report provides you with details such as: company name, license keys, month, and the number of protected mailboxes belonging to each managed company.

In the Monthly License Usage report, you can view the number of endpoints with Security for Exchange, but only for your information.

API

  • Use the getMonthlyUsage method to obtain the value for exchangeMonthlyUsage.

  • Use the getMonthlyUsagePerProductType method to obtain the object usages with "productType": 0 and the value for exchangeMonthlyUsage.

Note

For details, refer to getMonthlyUsage and getMonthlyUsagePerProductType.

Email Security

The usage for Email Security is calculated based on the number of active primary mailboxes (excluding aliases and distribution lists) that have sent or received at least one email during the month.

Tip

An Active Mailbox is a mailbox that has received or sent at least one email message in the period (month).

A received email is classified as an email received by the service that has been quarantined, delivered or an attempted delivery.

Important

Please also be aware of Bulk Email and Fair Usage terms.

Mailboxes are subject to billing if:

  1. The primary flag is set to true.

  2. The objectClass in Active Directory must be either user or NULL. (NULL is included for environments where Active Directory is not used).

Shared mailboxes, distribution Lists (DLs), and other similar resources are not counted towards product usage if:

  • objectClass is set to either group or msExchDynamicDistributionList for on-premise environments.

  • objectClass is set to sharedMailbox for cloud environments.

Note

If you are using Azure Active Directory you must grant the correct permissions to allow synchronization of shared mailboxes, otherwise they will be indistinguishable from standard users and subject to billing.

Tip

You can also Create a Powershell Script to list Office 365 Shared Mailboxes.

The GravityZone Security for Email Monthly License Usage report provides you with details such as: company name, license keys, month, and the number of protected mailboxes belonging to each company.

API

Note

For details, refer to getMonthlyUsage and getMonthlyUsagePerProductType.

  • Use the createReport method to generate the GravityZone Security for Email Monthly License Usage report via API.

  • Use the getMonthlyUsage method to obtain the value for emailSecurityMonthlyUsage.

  • Use the getMonthlyUsagePerProductType method to obtain the object usages with "productType": 0 and the value for emailSecurityMonthlyUsage.

GravityZone Security for Mobile

The usage for GravityZone Security for Mobile is calculated based on the number of active devices where the security agent is installed.

Mobile devices are subject to billing if:

  • The security agent is installed on the device.

  • The device is visible in the Mobile Security console.

  • The device is visible in the Mobile Security console and has been online at least once during the calendar month

The Mobile Security Monthly License Usage report provides you with details such as: company name, license keys, device ID, device model, device OS, device user, first seen and last seen.

API

Note

For details, refer to getMonthlyUsage and getMonthlyUsagePerProductType.

  • Use the createReport method to generate the GravityZone Security for Mobile Monthly License Usage report via API.

  • Use the getMonthlyUsage method to obtain the value for mobileSecurityMonthlyUsage.

  • Use the getMonthlyUsagePerProductType method to obtain the object usages with "productType": 0 and the value for mobileSecurityMonthlyUsage.

Container Protection

The usage for Container Protection is calculated based on the following criteria:

  • The number endpoints with Container Protection deployed.

  • If deployed on a virtual server, the instance will be deducted from the VS usage number.

  • If not deployed on a virtual server, the instance will be deducted from the endpoint usage number.

To obtain these data, you are provided with the following columns in the CSV file of the Monthly License Usage report:

  • Container Protection: if the add-on is activated

  • Container Protection Usage: number of endpoints with the module installed

  • Endpoint OS type: server or workstation.

  • Endpoint type: physical or virtual.

Usage for endpoints with services

The GravityZone services include:

Managed Detection and Response (Bitdefender MDR) for MSPs

The Managed Detection and Response (Bitdefender MDR) for MSPs service is called Foundations.

The usage for Bitdefender MDR Foundations is calculated by the number of endpoints with an installed EDR module, which have enabled this service during the month.

In the CSV file of the Monthly License Usage report, filter the corresponding columns by "Bitdefender MDR Foundations= Yes" to get the usage of this service.

Example of a monthly usage report

In a Monthly License Usage report, you have the following data presented in the CSV file:

monthly_report_csv_plain_340181_en.png

Click here to download the CSV file.

For enhanced clarity and readability, we have provided a visually improved CSV version. The columns are expanded, displaying clear header titles, and each company's information is presented in a distinct color, making it easier to comprehend and navigate the data:

monthly_report__csv_340181_en.png

Click here to download the visually improved version of the file.

The .CSV version of the report is split into two sections:

  1. The Usage section - this area provides a list of managed companies, and related information such as company settings, licensing information, the number of licensed endpoints and usage totals for add-ons and services.

    Note

    The license usage for some companies for specific add-ons will not be recorded and will be shown as 0 if the product is included in the protection model assigned to the company's own use.

  2. The Endpoint details section - this area provides a list of endpoints managed by each company, and related information such as endpoint type, operating system, hardware ID, IP, and usage information.

Usage section

The data indicates the following companies:

  • Partner 1 – Partner company with monthly license.

  • Customer A – Customer company under Partner 1, with monthly subscription, and using an A la carte protection model.

  • Customer B – Customer company under Partner 1, with monthly subscription, and using a Secure protection model.

  • Customer C – Customer company under Partner 1, with monthly subscription, and using a Secure Plus protection model.

  • Customer D - Customer company under Partner 1, with monthly subscription, and using a Secure Extra protection model.

Partner 1 has 22 licensed endpoints from a total of 100 reserved seats. The licensed endpoints are counted from the Customer A, Customer B, Customer C, and Customer D companies, which inherit reserved seats from Partner 1.

The usage for these companies is calculated by filtering relevant columns for each GravityZone service, in the endpoint details area.

Note

The license usage for some companies for specific add-ons will not be recorded and will be shown as 0 if the product is included in the protection model assigned to the company's own use.

Usage for companies with Bitdefender EDR

The usage is counted based on the number of endpoints that have used Bitdefender EDR during the month.

To get the usage, generate the Monthly License Usage report again with Bitdefender EDR as product type.

In the CSV file, the number of the endpoints is available in the Endpoint Usage column.

Example of a monthly usage report

In a Monthly License Usage report generated for Bitdefender EDR, you have the following data presented in the CSV file:

126797_1.png

Click the image to view it larger. Click here to download the above CSV file.

The data indicates the following companies:

  • Partner 1 – Partner company with monthly license and Endpoint Security as product type. Additionally, Partner 1 assigned Bitdefender EDR to its child companies.

  • Customer A – Customer company under Partner 1, with monthly subscription and Endpoint Security as product type.

  • Customer B – Customer company under Partner 1, with monthly subscription and Endpoint Security as product type.

  • Customer C – Customer company under Partner 1, with monthly subscription and Endpoint Security as product type.

  • Customer D - Customer company under Partner 1, with monthly subscription and Bitdefender EDR as product type.

The usage for Customer A, Customer B, and Customer C is zero, because all these companies use Endpoint Security.

The usage for Customer D, which uses Bitdefender EDR, is 3, as indicated in the Endpoint Usage column.

Because only Customer D has Bitdefender EDR usage in this report, the parent company Partner 1 indicates the same usage.

The CSV file also includes the endpoints list with the following usage per module: Advanced Threat Control, Content Control, Network Attack Defense, and Endpoint Detection and Response. All these modules are part of Bitdefender EDR as product type, so they do no generate additional usage.

Minimum usage

In GravityZone Control Center, the Monthly License Usage report displays minimum usage in the column with the corresponding name.

In the CSV file, the minimum usage is available in the Minimum usage column.

For details about Bitdefender offering for MSP, refer to Frequently Asked Questions (FAQ) about Bitdefender Cloud Security for MSP.

Create a Monthly License Usage report in GravityZone

This section explains how to create a Monthly License Usage report in GravityZone Control Center or by using APIs.

In GravityZone Control Center

To create a Monthly License Usage report, follow these steps:

  1. Log in to GravityZone Control Center.

  2. Go to the Reports page from the left side menu.

  3. Click Add in the action toolbar.

  4. Under Details, select Monthly License Usage and enter a specific report name, if needed.

  5. Under Settings, configure when the report to be generated, the interval, product type, and delivery by mail, according to your needs.

    • Select either Now, to instantly generate the report, or Scheduled, to set up a report to run periodically, at a specified time and date.

    • Under Reporting interval select the interval of time you would like to gather data from. This setting is based on the date the report is generated.

    • Under Product type, select the type of product you want to generate reports for.

    • (Optional) Select the Only Endpoint Details checkbox to show only endpoint related information in the report. This will ignore the companies' hierarchy.

    • (Optional) Select the Only Direct Companies checkbox for the report to include only information from child companies at the first level under the target company.

    • (Optional) Select the Only New Customer Companies checkbox to include only companies created between two specific dates in the report. When selected, these options appear below:

      • Company registration start date - only companies created after this start date will be included in the report.

      • Company registration end date - only companies created before this date will be included in the report.

      Important

      You must fill in both fields, otherwise no information will be included in the request.

  6. Under Delivery, select the format of the report and if you want to send it via e-mail.

  7. Under Select Target, select the companies you are interested in.

  8. Click Generate.

To obtain the CSV file, follow these steps:

  1. Generate a Monthly License Usage report.

  2. In the report page, click Export CSV.

  3. Choose Export details in csv.

  4. Select to open or to save the file when prompted by the web browser and confirm.

By using GravityZone APIs

You can obtain the Monthly License Usage report and its CSV file by calling certain API methods:

  1. Make a request for createReport.

    1. Parameters:

      1. "type": 13 (Monthly License Usage report)

      2. "targetIds": [string] (your own company ID or other companies)

    2. Options:

      1. "reportingInterval": 4 (for the last month)

      2. "skipSummary": true. The report will contain only the details. To include the summary, choose false.

  2. The response will return a result containing a string.

  3. Make a request for getDownloadLinks using the string as reportId parameter.

  4. The response will contain the downloading link for the report.

Examples

Request createReport:

        {
                "params": {
                        "name": "reportName",
                        "type": 13,
                        "targetIds": [
                                "5a8d349fb1a43d4d19f7ccc9"
                        ],
                        "options": {
                                "reportingInterval": 4,
                                "skipSummary": true
                        }
                },
                "jsonrpc": "2.0",
                "method": "createReport",
                "id": "e249c22c-0ada-4772-a9f1-ee1cbb322588"
        }

Response createReport:

        {
                "id": "e249c22c-0ada-4772-a9f1-ee1cbb322588",
                "jsonrpc": "2.0",
                "result": "5aa246f4b1a43db6152b95af"
        }

Request getDownloadLinks:

        {
                "params": {
                        "reportId": "5aa246f4b1a43db6152b95af"
                },
                "jsonrpc": "2.0",
                "method": "getDownloadLinks",
                "id": "e249c22c-0ada-4772-a9f1-ee1cbb322588"
        }

Response getDownloadLinks:

        {
                "id": "e249c22c-0ada-4772-a9f1-ee1cbb322588",
                "jsonrpc": "2.0",
                "result": {
                        "readyForDownload": true,
                        "lastInstanceUrl": "http://192.168.33.20:8221/api/v1.0/http/downloadReportZip?reportId=5aa246f4b1a43db6152b95af&allInstances=0"
        }

For details regarding the API methods regarding the license usage in GravityZone Cloud, refer to the GravityZone API Guide for Partners, specifically to these methods:

  • Companies – createCompany

  • Licensing – getLicenseInfo

  • Licensing – setMonthlySubscription

  • Licensing - getMonthlyUsage

  • Reports – createReport

To learn how to calculate the monthly license usage, refer to Calculate the endpoint usage with the Monthly License Usage report.

In this section: