Retrieval of license usage

You use the GET operation on the api/sam/license_usages element to request information about license usage reported by your computer systems.

This API retrieves peak license usage over the last 90 days. PVU and RVU full capacity and subcapacity license usage is retrieved only on the host computer system level. To retrieve information about license usage reported by your computer systems, use the following URL:
  • To use this API, you must be assigned to the All Computers group and have the View License Metrics permission.
  • Each API request must be authenticated with the token parameter. You can retrieve it by using REST API for retrieving authentication token. You can also log in to BigFix Inventory, hover over the User icon User icon, and click Profile. Then, click Show token.
  • This API retrieves data for the last 90 days, until the last successful import.
  • By default, the data retrieves is sorted by computer_system_id, software_title_id, and metric_name columns.
Table 1. Operation descriptions
Operation details Description
Operation GET /api/sam/license_usages
Purpose Returns information about license usage
HTTP method GET
Resource URI https://server_host_name:port_number/api/sam/license_usages
URL link relation n/a
URI query parameters For a list of applicable query parameters, see: Query parameters.
Request headers
Accept-Language (optional)
en-US (only English is supported)

Used to negotiate the language of the response. If this header is not specified, the content is returned in the server language.

Request payload n/a
Request Content-Type
  • application/json
Response headers

Specifies the content type of the response.

en-US, …

Specifies the language of the response content. If this header is not specified, the content is returned in the server language.

none, idle, running, pending

Specifies the import status.

A percentage value, for example 59.

Specifies the percentage progress of an import.

successful, failed

Specifies the status of the last import.

Date, for example 2014-06-18T04:00:29Z.

Specifies the time of the last successful import.

Response payload License Usages element
Response Content-Type
  • application/json
Normal HTTP response codes
  • 200 – OK
Error HTTP response codes
  • 500 – "Bad Request" if a query parameter contains errors or is missing

Message body includes an error message with details.

Query parameters

You can use query parameters to narrow down the results of your search. The following table presents query parameters that you can use for the api/sam/license_usages element.
Table 2. Query parameters for retrieving license usage
Parameter Description Required Value
columns[] Specify which columns to retrieve. If you do not specify this parameter, a set of default columns is retrieved. Example:
Retrieve the name and version columns:
No String
order Specify how to sort the returned data. The default direction for sorting columns is ascending. If you want to specify a descending sort, append desc to the column name. Example:
Order by peak license usage descending:
URL?order[]=peak_value desc
No String
limit Specify the number of rows to retrieve. If you omit this parameter, all rows are retrieved. No Numeric
offset Specify the number of rows to skip for retrieving results. You can use it together with the limit parameter to paginate results. Example:
Retrieve 50 records starting after record 150:
No Numeric
token A unique user authentication identifier. You can view your token in the Profile preferences of BigFix Inventory. Yes Alphanumeric
criteria Retrieve records which match specific conditions. The parameter should have the following structure, written on one line:
<criteria> ::= <left-brace> <boolean-operator><colon> <left-bracket> 
<criterion> [{ <comma> <criterion> }...] <right-bracket> <right-brace>
<boolean-operator> ::= "and" | "or"
<criterion> ::= <criteria> | <left-bracket> <column> <comma> <operator> <comma> <value> <right-bracket>
<column> ::= <json-string>
<operator> ::= <json-string>
<value> 	::= <json-array> | <json-string> | <json-numver> | <json-null>

For more information about operators, see Common connectors and operators.

Example: Retrieve license usage for software whose publisher name contains "BigFix":
URL?criteria={ "and": [ ["publisher_name", "contains", "BigFix"]]}

Example HTTP conversation

GET api/sam/license_usages
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
Response header
HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US
The above response header may be followed by different entries, depending on the current status of the data import which is represented by Import-Mode. To understand the returned values, see the following definitions:
  • none - a data import has never been initiated
  • idle - no data imports are currently running
  • running - a data import is in progress
  • pending - an action performed in the user interface requires a data import to be started for the change to take effect
If a data import has never been initiated:
Import-Mode: none
If a data import is in progress:
Import-Mode: running
Import-Progress: 41
If a data import is not running:
Import-Mode: idle/pending
Import-Last-Status: successful
Import-Last-Success-Time: Mon, 23 Jun 2014 12:18:29 GMT
Response body (JSON)
If a particular entry is hidden by default, it is not retrieved by using the general URL. To retrieve such data, you must use query parameters to specify the name of the hidden column. For example, you can retrieve the column by using the columns[] parameter:
"software_title_id": 36181,
"metric_name": "RVU_FULL_CAP",
"computer_system_id": 4,
"peak_value": 1,
"peak_date": "2014-04-14",
"peak_time": "2014-04-14T13:05:10Z",
"reporting_period_start_date": "2014-04-01",
"reporting_period_end_date": "2014-04-30",
"software_title_dimension":   //hidden by default 
   "name": "BigFix Protection",
   "guid": "d78048cf-842b-44e8-8036-e7e2bf8afb31",
   "publisher_name": "BigFix",
   "publisher_guid": "8a759f0c-b91a-4d7d-8c4a-a9d85e06c13d"