Pre-release announcement: API changes for Extended Email Security reporting

Date: 2025.10.09

We will soon be implementing a new add-on for companies with monthly subscriptions, enabling the purchase and use of the Extended Email Security product. Extended Email Security filters and protects inbound and outbound email traffic by detecting and blocking spam, phishing, malware, and other malicious content before it reaches your mailboxes, helping ensure safer email communication.

To prepare for this change, we’re informing you in advance about planned updates to our API mehtods, so you can make any necessary adjustments to your automated tools or integrations. The new attribute extendedEmailSecurityMonthlyUsage will be added to the responses of the existing methods getMonthlyUsage and getMonthlyUsagePerProductType, and will track the monthly usage of this new add-on:

getMonthlyUsage

{
  "result": {
    "endpointMonthlyUsage": 4,
    "encryptionMonthlyUsage": 0,
    "emailSecurityMonthlyUsage": 0,
    "extendedEmailSecurityMonthlyUsage": 0
    "mobileSecurityMonthlyUsage": 0,
    "exchangeMonthlyUsage": 0,
    "atsMonthlyUsage": 0,
    "edrMonthlyUsage": 0,
    "edrStorage90DaysUsage": 0,
    "edrStorage180DaysUsage": 0,
    "edrStorage1YearUsage": 0,
    "mdrFoundationsMonthlyUsage": 0,
    "patchManagementMonthlyUsage": 0,
    "integrityMonitoringUsage": 0,
    "integrityMonitoring90DaysUsage": 0,
    "integrityMonitoring180DaysUsage": 0,
    "integrityMonitoring1YearUsage": 0,
    "sveVsMonthlyUsage": 0,
    "sveVdiMonthlyUsage": 0,
    "containerProtectionMonthlyUsage": 0,
    "xdrIdentitySensorsMonthlyUsage": 0,
    "xdrProductivitySensorsMonthlyUsage": 0,
    "xdrNetworkSensorsMonthlyUsage": 0,
    "xdrCloudSensorsMonthlyUsage": 0,
    "phasrMonthlyUsage": 0,
    "easmMonthlyUsage": 0,
    "complianceMonthlyUsage": 2,
    "aLaCarteMonthlyUsage": 1,
    "mspSecureMonthlyUsage": 1,
    "mspSecurePlusMonthlyUsage": 0,
    "mspSecureExtraMonthlyUsage": 2
  },
  "jsonrpc": "2.0",
  "id": "5986",
  "error": null
}

getMonthlyUsagePerProductType

{
  "result": {
    "usages": [
      {
        "endpointMonthlyUsage": 3,
        "encryptionMonthlyUsage": 0,
        "atsMonthlyUsage": 0,
        "edrMonthlyUsage": 0,
        "edrStorage90DaysUsage": 0,
        "edrStorage180DaysUsage": 0,
        "edrStorage1YearUsage": 0,
        "mdrFoundationsMonthlyUsage": 0,
        "patchManagementMonthlyUsage": 0,
        "integrityMonitoringUsage": 0,
        "integrityMonitoring90DaysUsage": 0,
        "integrityMonitoring180DaysUsage": 0,
        "integrityMonitoring1YearUsage": 0,
        "sveVsMonthlyUsage": 0,
        "sveVdiMonthlyUsage": 0,
        "emailSecurityMonthlyUsage": 0,
        "extendedEmailSecurityMonthlyUsage": 0,
        "mobileSecurityMonthlyUsage": 0,
        "exchangeMonthlyUsage": 0,
        "containerProtectionMonthlyUsage": 0,
        "xdrIdentitySensorsMonthlyUsage": 0,
        "xdrProductivitySensorsMonthlyUsage": 0,
        "xdrNetworkSensorsMonthlyUsage": 0,
        "xdrCloudSensorsMonthlyUsage": 0,
        "phasrMonthlyUsage": 3,
        "easmMonthlyUsage": 2,
        "complianceMonthlyUsage": 2,
        "productType": 0,
        "aLaCarteMonthlyUsage": 0,
        "mspSecureMonthlyUsage": 3,
        "mspSecurePlusMonthlyUsage": 0,
        "mspSecureExtraMonthlyUsage": 0
      },
      {
        "endpointMonthlyUsage": 0,
        "mdrFoundationsMonthlyUsage": 0,
        "productType": 3
      }
    ]
  },
  "jsonrpc": "2.0",
  "id": "2821",
  "error": null
}

Important

This update has not yet been implemented. This announcement is solely intended to help you prepare for the upcoming change. We will announce the release through our regular communication channels.

New API method: `getExtendedEmailSecurityFilteredUsage`

Alongside the updates to the existing API methods described above, we are also introducing a new method, getExtendedEmailSecurityFilteredUsage, available starting with the same release.

This method allows partners to retrieve Extended Email Security usage data for companies that are migrating from Email Security to Extended Email Security under specific eligibility conditions.

Request

Example

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

Parameters

targetMonth (string, required) – The reporting month the report will display data for, in MM/YYYY format.
companyId (string, optional) – The ID of the company for which the data is requested.
Default value: The ID of the company associated with the API key used for the request.

Response

Example

{
  "result": {
    "extendedEmailSecurityMonthlyUsage": 2387
  },
  "jsonrpc": "2.0",
  "id": "5087eab8-b74f-4a3e-85b3-4271e85890d4"
}

The extendedEmailSecurityMonthlyUsage value represents the number of mailboxes where the Extended Email Security feature was used and usage was registered for the specified company and month.

Use case

The getExtendedEmailSecurityFilteredUsage method was introduced to help partners accurately record and analyze the Extended Email Security (EES) usage generated by the companies they manage that participate in Bitdefender’s Loyalty Program.

By providing separate reporting for total and loyalty-based usage, the new API method enables distributors and MSP partners to identify which of their managed companies qualify for Loyalty Program benefits and how much eligible activity they generate. This distinction allows for more precise business reporting, simplifies validation of incentive eligibility, and helps partners measure the overall impact of their loyalty-driven deployments.

To identify which MSP partners generate loyalty-based Extended Email Security usage, you can use the new API method together with the existing usage methods:

getMonthlyUsage (or getMonthlyUsagePerProductType) returns the total Extended Email Security usage for an MSP, including both standard and loyalty-based data.
getExtendedEmailSecurityFilteredUsage returns only the usage generated by MSPs qualified for the Loyalty Program.

By comparing the results of these two API calls, distributors can easily determine which MSPs are loyalty partners and how much loyalty-based Extended Email Security usage they have generated.

Note

GravityZone does not directly expose the loyalty status of an MSP through a single API field, you infer it by comparing the two results.

For example, to calculate usage, follow these steps:

Send a request using the getMonthlyUsage method and record the value returned in the extendedEmailSecurityMonthlyUsage attribute.
This will return the total Extended Email Security usage for that company and its customers:
```
{
  "mspId": "MSP#1",
  "extendedEmailSecurityMonthlyUsage": 0
}
```
Send a request using getExtendedEmailSecurityFilteredUsage and record the value returned in the extendedEmailSecurityMonthlyUsage attribute.
This will return the Extended Email Security usage only for the companies that are recognized as part of the Loyalty Program and generate loyalty-based activity:
```
{
  "mspId": "MSP#1",
  "extendedEmailSecurityMonthlyUsage": 0
}
```
Compare the two results to classify the company. To do this, follow these rules:
- If the value returned by the getExtendedEmailSecurityFilteredUsage is 0, either the company is not a loyalty partner, or they are a loyalty partner but have not migrated any customers that generate loyalty-based usage yet.
- If the filtered value is greater than 0, the company is a loyalty partner and has generated loyalty-based Extended Email Security usage.
Repeat steps 1 to 3 for all your managed companies.

Example classification table

Company	Total Extended Email Security usage	Extended Email Security usage for loyalty partners	Interpretation
MSP#1	350	0	The target company is not a loyalty partner, or is a loyalty partner with no migrated customers yet.
MSP#2	520	520	The target company is a loyalty partner with active migrated customers generating loyalty-based usage.
MSP#3	0	0	There is no Extended Email Security usage at all. The company is either not selling or not deploying the product.

Tip

Run the comparison monthly or on your regular reporting cadence to track changes in migration and loyalty usage over time.

In this section: