getMonthlyUsage
This method exposes the monthly usage for a company in a target month. Returns only usage from endpoints with the default product type - Endpoint Security. If usage from other product types is needed, refer to the getMonthlyUsagePerProductType method.
Parameters
Parameter | Type | Optional | Description |
---|---|---|---|
| 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. |
| String | Yes | The month for which the usage is returned. It should have the following format: |
Return value
This method returns an Object containing the number of license seats used during the specified month, for each acquired service, or 0 if the queried company does not have a monthly license:
endpointMonthlyUsage
- the monthly usage for endpoints scanned with local engines.emailSecurityMonthlyUsage
- the monthly usage for Email Security mailboxes.exchangeMonthlyUsage
- the monthly usage for Exchange mailboxes.encryptionMonthlyUsage
- the monthly usage for the encryption module.atsMonthlyUsage
- the monthly usage for the sandboxAnalyzer and hyperDetect modules.edrMonthlyUsage
- the monthly usage for the EDR module.mdrFoundationsMonthlyUsage
- the monthly usage for MDR Foundationsservice.mdrResponseMonthlyUsage
- the monthly usage for MDR Response service.patchManagementMonthlyUsage
- the monthly usage for the patch management module.containerProtectionMonthlyUsage
- the monthly usage for container protection module.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.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.
Example
Request:
{
"params": {
"targetMonth": "03/2015",
"companyId": "55115935b1a43dcc4a7b23c6"
}, "jsonrpc": "2.0",
"method": "getMonthlyUsage",
"id": "5087eab8-b74f-4a3e-85b3-4271e85890d4"
}
Response:
{ "id": "5087eab8-b74f-4a3e-85b3-4271e85890d4", "jsonrpc":"2.0", "result": { "endpointMonthlyUsage": 101, "emailSecurityMonthlyUsage": 162, "exchangeMonthlyUsage": 15, "encryptionMonthlyUsage": 69, "atsMonthlyUsage": 25, "edrMonthlyUsage": 14, "mdrFoundationsMonthlyUsage": 14, "mdrResponseMonthlyUsage": 0, "patchManagementMonthlyUsage": 28, "containerProtectionMonthlyUsage": 12, "sveVsMonthlyUsage": 5, "sveVdiMonthlyUsage": 30, "minimumUsage": { "endpointMonthlyUsage": 25 } } }