PARTNERS

getMonthlyUsagePerProductType

The method exposes the monthly usage of a company in a target month. Returns the usage per product type, for all available product types.

Parameters

Parameter

Type

Optional

Description

companyId

String

Yes

The ID of the company. The default value is the ID of the company linked to the user who generated the API key.

targetMonth

String

Yes

The month for which the usage is returned. It should have the following format: mm/yyyy. The default value is the current month.

Return value

This method returns an Object containing the following:

  • usages - An array of Objects that contain the number of license seats used during the specified month, for each acquired service and product type.

    For Endpoint Security, the object contains the following members:

    • productType, the product type.

    • endpointMonthlyUsage, the monthly usage for endpoints scanned with local engines.

    • mdrFoundationsMonthlyUsage, the monthly usage for the MDR Foundations service (MdrFoundations).

    • mdrResponseMonthlyUsage, the monthly usage for the MDR Response service (MdrResponse).

    • emailSecurityMonthlyUsage, the monthly usage (mailboxes) for Email Security (mailboxes).

    • exchangeMonthlyUsage, the monthly usage (mailboxes) for Exchange Protection.

    • encryptionMonthlyUsage, the monthly usage for Full Disk Encryption.

    • atsMonthlyUsage, the monthly usage for the Sandbox Analyzer and HyperDetect.

    • edrMonthlyUsage, the monthly usage for the Endpoint Detection and Response (EDR).

    • containerProtectionMonthlyUsage, the monthly usage for Container Protection.

    • patchManagementMonthlyUsage, the monthly usage for Patch Management.

    • sveVsMonthlyUsage, the monthly usage for virtual servers scanned with Security Server.

    • sveVdiMonthlyUsage, the monthly service usage (in hours) for virtual desktops scanned with Security Server.

    For Bitdefender EDR, the object contains the following members:

    • productType, the product type.

    • endpointMonthlyUsage, the monthly usage for endpoints scanned with local engines.

    • mdrFoundationsMonthlyUsage, the monthly usage for the MDR Foundations service (MdrFoundations).

    • mdrResponseMonthlyUsage, the monthly usage for the MDR Response service (MdrResponse).

  • minimumUsage - An Object containing types of licenses and the minimum number of slots which the company commits through legal agreement to use on a monthly basis:

    • endpointMonthlyUsage, the minimum number of endpoints that the client agreed to use from the main license.

    If the queried company does not have a monthly license or subscription, the method returns 0.

Example

Request:

  {
       "params": {
           "targetMonth": "03/2015",
           "companyId": "55115935b1a43dcc4a7b23c6"
       },
       "jsonrpc": "2.0",
       "method": "getMonthlyUsagePerProductType",
       "id": "5087eab8-b74f-4a3e-85b3-4271e85890d4"
  }  

Response:

  {
      "id": "5087eab8-b74f-4a3e-85b3-4271e85890d4",
      "jsonrpc":"2.0",
      "result": {
           "usages": [{
                 "endpointMonthlyUsage": 101,
                 "emailSecurityMonthlyUsage": 162,
                 "exchangeMonthlyUsage": 15,
                 "encryptionMonthlyUsage": 69,
                 "atsMonthlyUsage": 25,
                 "edrMonthlyUsage": 14,
                 "mdrFoundationsMonthlyUsage": 14,
         	 "mdrResponseMonthlyUsage": 0,
                 "patchManagementMonthlyUsage": 28,
                 "containerProtectionMonthlyUsage": 12,
                 "sveVsMonthlyUsage": 5,
                 "sveVdiMonthlyUsage": 30,
                 "productType": 0,
            },
                {
                 "endpointMonthlyUsage": 101,
                 "mdrFoundationsMonthlyUsage": 0,
        	 "mdrResponseMonthlyUsage": 2,
                 "productType": 3
            }],
           "minimumUsage": {
                 "endpointMonthlyUsage": 25
            },
      }
  }