Device Level Usage

post

https://prod-nableboomi.n-able.com:443/ws/rest/V3/Channel_UP_API/UsageDetailsDevices/{sfdcid}/{TimeFrame}/{ContractId}

Retrieves device level usage, summarized by device and by client.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint allows the user to retrieve detailed usage data for a specified contract in a given month. This data is broken down to the end customer device level, allowing for accurate allocation of usage charges by the MSP. It furthermore returns committed and account level charges in separate arrays when present.

Path Params

ContractId

string

required

Contract ID for which to retrieve data. This is unique to the customer.

TimeFrame

string

required

Month Timeframe for which to retrieve data.

sfdcid

string

required

Unique Identifier retrieved from N-Able. Required for authorisation.

Headers

x-api-key

string

required

API key. Required for authorisation.

User-Agent

string

required

Identifies the client application making the request. When scripting or calling this API programmatically, specify a custom User-Agent, as default User-Agents (e.g. those set automatically by HTTP libraries or tools like curl) may be blocked for security purposes.

Content-Length

integer

required

The size of the request body, in bytes.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Success response. Returns JSON with array of client and device usage.

401Unauthorized request

403Forbidden Request - There may be invalid fields in the request.

404No Data found. Please verify input parameters.

429Too many requests in a short amount of time.

500Internal Server Error - This generic error message appears when an unexpected condition was encountered and a more specific message is not suitable.