Get Floating Capacity Licenses

This method identifies the licenses contributing to excess or unused capacity in a specific 30-minute UTC interval.

This method requires Usage Analytics permission. Returning customer names, company names, and email addresses also requires Get Customers permission.

It returns capacity license objects.

Parameters

This method is accessed by https://api.cryptolens.io/api/ai/GetFloatingCapacityLicenses

Results

Example results

This response follows the interval from the Get Floating Capacity example. License 12345 has 12 floating machines against a limit of 10. IDs and values are illustrative.

{
  "productId": 3349,
  "intervalStartUtc": 1790856000,
  "capacityMode": "exceeded",
  "hasData": true,
  "licenses": [
    {
      "productId": 3349,
      "productName": "Example product",
      "keyId": 12345,
      "key": "AAAA-BBBB-CCCC-DDDD",
      "customerId": null,
      "customerName": null,
      "customerCompany": null,
      "customerEmail": null,
      "floatingMachines": 12,
      "maxNoOfMachines": 10,
      "capacityValue": 2,
      "isCurrent": false,
      "sourceUpdatedUtc": 1790856120
    }
  ],
  "page": 1,
  "limit": 100,
  "total": 1,
  "returned": 1,
  "generatedUtc": 1793102400,
  "result": 0,
  "message": null
}

Remarks

• This method supports GET with query parameters and POST with a form or JSON body. Send the access token in the token header, query string, or form field. For JSON requests, use Content-Type: application/json and send the token separately; it is not read from the JSON body.
• JSON responses use camel-case field names. All timestamps are Unix seconds in UTC; date strings use yyyy-MM-dd.
• An out-of-range page returns an empty list. Total counts all rows in the authorized result before pagination; Returned counts only this page.
• Product and key locks restrict the result before counting and paging. With a key-locked token, only the authorized key can be returned.
• Only tracked licenses with a positive configured maximum can match. Usage equal to the maximum is excluded in both modes. CapacityValue is the signed difference between FloatingMachines and MaxNoOfMachines.
• CustomerId is returned only when the linked customer belongs to the same account. CustomerName, CustomerCompany, and CustomerEmail additionally require the token's Get Customers permission. Missing or disallowed details are null.
• Historical records for deleted licenses may retain product and key IDs with null license details.
• HasData is independent of the requested page and capacity mode. An empty Licenses list may mean no licenses matched or the page is beyond the results; check Total and HasData.
• The current interval uses asynchronously maintained current state. Historical intervals restore the last state before the interval end. An untracked state must not be interpreted as zero usage.
• SourceUpdatedUtc is the source record's update or recording time. Values do not represent every instantaneous peak, and separate requests may observe background updates.
• To investigate a license further, pass its ProductId and KeyId to Get Floating Capacity History.

Example request

Replace YOUR_USAGE_ANALYTICS_TOKEN and the sample identifiers with your own values. This POST example sends form-encoded parameters.

curl -X POST https://api.cryptolens.io/api/ai/GetFloatingCapacityLicenses \
  --data-urlencode "token=YOUR_USAGE_ANALYTICS_TOKEN" \
  --data-urlencode "ProductId=3349" \
  --data-urlencode "IntervalStartUtc=1790856000" \
  --data-urlencode "CapacityMode=exceeded" \
  --data-urlencode "Page=1" \
  --data-urlencode "Limit=100"

Errors

Errors return Result=1 with an explanation in Message. Common errors include: