License usage

Query the installed license types and their usage.

Peak license usage (technical preview)

The license_usage resource enables you to query the peak periodic usage of concurrent licenses. Reports can be created at the site and space levels.

Syntax

Site-level report: GET .../api/admin/license_usage?<parameters>
Space-level report: GET .../api/shared_spaces/<space_id>/license_usage?<parameters>

Note: Use the ALM-OCTANE-TECH-PREVIEW=true header key.

Parameters

The following parameters can be used to filter the results:

Parameter	Description
start_date	The start date of the reporting period (YYYY-MM-DD). Example: start_date=2024-09-07 If no start date is given, the report begins 3 days before the present.
end_date	The end date of the reporting period (YYYY-MM-DD). Example: end_date=2024-10-09 If no end date is given, the report ends at the present date.
time_unit	Determines the time interval between the data points in the report. Possible values: days, weeks, months Default: days
space	For the site-level report. Specify a space ID.

Request

GET /api/shared_spaces/1001/license_usage?start_date=2024-10-30&end_date=2024-10-31

Response

Copy code

{
    "license_usage": {
        "2024-10-30:00:00.000+0000": 150,
        "2024-10-31:00:00.000+0000": 143
        }
    "space_id":1001,
    "start_date": "2024-10-7",
    "end_date": "2024-10-13",
}