Monthly
Call description
This call returns a monthly product usage report (including seat days) for a specified company. The report consists of a product list that belongs to the current company.
•This API call requires authorization; the user has to be logged in.
•Request URL: https://mspapi.eset.com/api/UsageReport/Monthly/products
•This request is a POST call type.
Call structure
{
"codes": [
"string"
],
"from": "",
"to": "",
"companyId": "string",
"skip": 0,
"take": 0
}
Call parameters
Parameter |
Description |
|---|---|
codes |
The product codes are numeric identifiers for ESET products. The list of codes is available using the AvailableProducts call. You can type in one or more codes. To enter additional product codes, use the following syntax: "codes": ["code_1","code_2","code_3"] Replace the code_x placeholders with the actual values. |
from, to |
The from and to parameters specify the date boundaries for the report. The date must be in the format YYYY-MM-DD, for example 2018-12-21. Mandatory input parameter. A proper value must be set. |
companyId |
companyId is a unique identifier of a company. To get the companyId of the logged in user, use /api/User/Current call. Do not use DivisionId instead of companyId, ESET MSP Administrator 2 API would return only an empty list of companies. Mandatory input parameter. A proper value must be set. |
skip, take |
If the requested data set is too large, you can split the response into smaller chunks. It works similarly to the paging function. The skip parameter indicates how many entries should be skipped and the take parameter indicates how many entries should be listed. The take value must be from 1 to 100. For example: •to list the first 20 entries, set up: "skip": 0, "take": 20 •to list the second 20 entries (from 21 to 40), set up: "skip": 20, "take": 20 |
Response structure
The response contains data in the JSON format.
|
•seatDays is the integer value for the total number of days a product was used on all devices. For example, if you have 3 devices that used a product for 2 days, that equals 6 seat days of product usage. •seats is the number of ordered units on the last day in the reported interval. The seats value is zero, if the license is suspended on the last day.. |
Troubleshooting
ESET MSP Administrator 2 API uses standardized error codes. If you are getting errors or unexpected responses, see the Troubleshooting API for common problems and the list of error codes.