post
https://prod-nableboomi.n-able.com:443/ws/rest/V1/PSA_API/PSAUsageByTimeFrame//
This endpoint provides detailed device-level usage data for all available products for a specified timeframe.
This endpoint is for use by Indirect and direct customers
The detailed usage data is structured as a nested format, providing comprehensive records for all end customers (clients) per product.
Each client record includes:
A list of devices with detailed information. Aggregated total usage by service for each customer, including metrics such as the amount of usage, price, and associated product features.
Sample response
{
"UsageDetailDevices":[
{
"AccountName": "Best MSP",
"BpAccountId": 12348,
"Cid": "234578",
"ContractId": 234578,
"ContractNumber": "MSP-234578-01",
"ContractStatus": "ACTIVE",
"Created": "2021-01-04 20:02:13.470",
"PgaCode": "0100",
"Pid": "0118M-0000-0000-UK",
"ProductName": "Cove Data Protection | Data Protection Plan | MSP",
"RateClassId": "234567",
"SfdcAccountId": "001H234578asdfIAS",
"TenantId": "0100_678905",
"TimeFrame": 202405,
"Updated": "2023-12-31 22:09:37.204",
"TotalByContracts": [
{
"AccountName": "Best MSP",
"BpAccountId": "345678",
"Cid": "234578",
"ContractId": "234567",
"ContractNumber": "MSP-234578-01",
"InvoiceId": "123467",
"SfdcAccountId": "001H234578asdfIAS",
"AdditionalCapacity": [
{
"AdditionalCapacity": "-1835.062000000002",
"SelectedGbUsageQuantity": "2714.937999999998",
"Servers": {
"CommittedCount": 4,
"DeviceCount": 5,
"FUP": 2000,
"Pool": 10000,
"UsageCount": 5
},
"TimeFrame": 202405,
"TotalPool": 45500,
"UsedGB": "2714.937999999998",
"UsedGbUsageQuantity": "4514.326999999997",
"VirtualServers": {
"CommittedCount": 17,
"DeviceCount": 17,
"UsageCount": 15
},
"Workstations": {
"CommittedCount": 2,
"DeviceCount": 3,
"FUP": 500,
"Pool": 1500,
"UsageCount": 3
}
}
]
}
],
"Clients": [
{
"ClientId": 2712428,
"Devices": [
{
"Detail": "user",
"DetailId": "deviceid",
"Customer Site Name": "site",
"UsageCompanyName": "customername",
"UsageLevel_5": "Best MSP",
"UsageLevel_3": "Distributor",
"TotalByService": [
{
"BillingServiceName": "Cove Data Protection | Microsoft 365 Protection",
"ProductFeatureName": "0100_O365_PROTECTION",
"Quantity": 1,
"Sku": "MSPUK-BU-O365PRO",
"Uom": "Users"
}
]
}
],
"Name": "Best MSP",
"TotalByService": [
{
"BillingServiceName": "Cove Data Protection | Microsoft 365 Protection",
"ProductFeatureName": "0100_O365_PROTECTION",
"Quantity": 3,
"Sku": "MSPUK-BU-O365PRO",
"Uom": "Users"
}
]
}
]
}
]
}