Get usage details for a process

get

https://api.controlup.com/historical/v1/processes/usage/single

Returns usage details for the specified process including usage per machine, per user account, peak concurrent instances, and unique user count throughout the search period.

Query Params

processName

string

required

^[\w.\-\s]+$

The name of the process

processVersion

string

^[\w.\-\s]+$

Only return usage details for the specified process version.

_timeFrom

date-time

required

Start date and time of the search period in the format: YYYY-MM-DD'T'hh:mm:ss.sssZ

_timeTo

date-time

required

End date and time of the search period in the format: YYYY-MM-DD'T'hh:mm:ss.sssZ

userAccounts

array of strings

Filter by user accounts in Domain\username format. Maximum 50 items.

userAccounts

computerNames

array of strings

Filter by computer names. Maximum 100 items. Unknown names are resolved to -1 and match nothing.

computerNames

_page

int32

≥ 1

The page number returned. The first page is 1.

_limit

int32

1 to 100000

The number of items returned per page. Minimum is 1.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successfully retrieved

400Bad Request - one of the inputs isn't correct

401User is not authorized to access the resource

403Authorization details are not provided

500Internal Server Error

501Internal Server Error

504Internal Server Error