> ## Documentation Index
> Fetch the complete documentation index at: https://help.cryptolens.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Report Results

> Response fields, data types, and availability rules shared by the floating-capacity and expiring-license reports.

Response fields, data types, and availability rules shared by the floating-capacity and expiring-license reports.

All four report methods require **Usage Analytics** permission.
Returning customer names, company names, and email addresses also requires **Get Customers** permission.

Response structures for [Get Floating Capacity](https://help.cryptolens.io/api-reference/generated/GetFloatingCapacity.md),
[Get Floating Capacity Licenses](https://help.cryptolens.io/api-reference/generated/GetFloatingCapacityLicenses.md),
[Get Floating Capacity History](https://help.cryptolens.io/api-reference/generated/GetFloatingCapacityHistory.md), and
[Get Expiring Licenses](https://help.cryptolens.io/api-reference/generated/GetExpiringLicenses.md).
Each method page documents its top-level response fields.

JSON responses use camel-case field names. All timestamps are Unix seconds in UTC; date strings use yyyy-MM-dd. Unless stated otherwise, fields in a successful response are not null.

### Common result fields

These fields accompany successful report responses. Errors use the BasicResult envelope containing Result and Message; report data and pagination fields are returned on success.

| **Parameter** | **Description** | **Remarks** |
| - | - | - |
| Result | Whether the request succeeded: 0 for success, 1 for error. | An integer. Always returned. |
| Message | Additional information about the result, including an explanation of errors. | A string, or null when there is no message. Always returned. |
| Page | The resolved one-based page number. | An integer. Returned on success. |
| Limit | The resolved maximum number of rows per page. | An integer. Returned on success. |
| Total | The number of rows in the authorized result before pagination. For expiry, this counts the selected Window; for the overview, it includes periods without findings or data. | An integer. Returned on success. |
| Returned | The number of rows included on this page. It can be zero even when Total is positive. | An integer. Returned on success. |
| GeneratedUtc | The UTC time captured once for the request. Separate pages are separate requests and may observe updated data. | A Unix timestamp in seconds. Returned on success. |

### Capacity periods

Objects in **Periods** returned by [Get Floating Capacity](https://help.cryptolens.io/api-reference/generated/GetFloatingCapacity.md).

| **Parameter** | **Description** | **Remarks** |
| - | - | - |
| ProductId | The product ID. | An integer. |
| ProductName | The product name. | A string, or null if unavailable. |
| PeriodStartUtc | The start of the returned UTC day or 30-minute interval. | A Unix timestamp in seconds. |
| WorstIntervalStartUtc | The 30-minute interval represented by this row. Pass it as IntervalStartUtc when retrieving affected licenses. Daily ties select the earliest interval. | A Unix timestamp in seconds, or null when HasData is false. |
| CapacityValue | The sum of positive excesses in exceeded mode, or negative unused-capacity differences in below mode. A daily row uses the most extreme interval value. | An integer. Zero when no finding exists; check HasData to distinguish missing data. |
| TrackedLicenseCount | The number of tracked licenses with positive limits in the represented interval. | An integer. Daily rows use the worst interval's count; zero without data. |
| LicensesAtOrAboveLimit | The number of tracked licenses whose floating-machine count meets or exceeds their positive limit. | An integer. Daily rows use the worst interval's count; zero without data. Equality is counted here but is not an exceeded finding. |
| HasData | Whether tracked capacity data with a positive limit exists for the period. | A Boolean. |
| HasFinding | Whether the period has excess or unused capacity in the selected mode. | A Boolean. True when CapacityValue is nonzero. |
| IsCurrent | Whether the returned day or interval contains the current UTC interval. | A Boolean. This does not guarantee fresh or available data. |
| SourceUpdatedUtc | The latest source update contributing to the interval, or to any interval in a daily row. This does not establish freshness for every license. | A Unix timestamp in seconds, or null when HasData is false. |

### Capacity summary

The **Summary** from Get Floating Capacity covers the full authorized date range, independently of Page and Limit.

| **Parameter** | **Description** | **Remarks** |
| - | - | - |
| MonitoredProductCount | Distinct products with valid tracked capacity data in the range. | An integer. |
| MatchingProductCount | Distinct products with a finding in the selected CapacityMode anywhere in the range. | An integer. |
| MatchingLicenseCount | Distinct licenses with a finding in the selected CapacityMode anywhere in the range. | An integer. |

### License identity and customer fields

These fields are included in capacity-license and expiring-license rows. Customer fields refer only to customers belonging to the same account. Missing or disallowed details are null; historical capacity records can retain numeric IDs after a license is deleted.

| **Parameter** | **Description** | **Remarks** |
| - | - | - |
| ProductId | The product ID. | An integer. |
| ProductName | The product name, when license details are available. | A string, or null. |
| KeyId | The license key ID. | An integer. |
| Key | The license key string, when the license still exists and its details are available. | A string, or null. |
| CustomerId | The ID of the linked customer, if the customer belongs to the same account. | An integer, or null. Does not require Get Customers permission. |
| CustomerName | The linked customer's name. | A string, or null. Requires Get Customers permission and same-account ownership. |
| CustomerCompany | The linked customer's company name. | A string, or null. Requires Get Customers permission and same-account ownership. |
| CustomerEmail | The linked customer's email address. | A string, or null. Requires Get Customers permission and same-account ownership. |

### Capacity license fields

Objects in **Licenses** returned by [Get Floating Capacity Licenses](https://help.cryptolens.io/api-reference/generated/GetFloatingCapacityLicenses.md) contain the [license identity and customer fields](https://help.cryptolens.io/api-reference/generated/model/ReportResults.md#license-identity-and-customer-fields) above, plus the following fields.

| **Parameter** | **Description** | **Remarks** |
| - | - | - |
| FloatingMachines | The recorded number of floating machines at the selected state. | An integer. |
| MaxNoOfMachines | The configured maximum at that state. | A positive integer. This may differ from the license's present limit. |
| CapacityValue | FloatingMachines minus MaxNoOfMachines. | An integer. Positive in exceeded mode, negative in below mode. |
| IsCurrent | Whether this row describes the current interval's tracked state. | A Boolean. This does not guarantee that background updates are instantaneous. |
| SourceUpdatedUtc | The source state's recording or update time. | A Unix timestamp in seconds. |

### History point fields

Objects in **Points** returned by [Get Floating Capacity History](https://help.cryptolens.io/api-reference/generated/GetFloatingCapacityHistory.md). Points retain tracking gaps and historical capacity limits.

| **Parameter** | **Description** | **Remarks** |
| - | - | - |
| TimestampUtc | The effective point time: the interval start for a recorded change, the range start for a carried baseline, or GeneratedUtc for an appended current state. | A Unix timestamp in seconds. |
| SourceUpdatedUtc | The source state's recording or update time, preserved for baselines and current state. | A Unix timestamp in seconds. |
| NodeMachines | The recorded number of node-locked machines. | An integer. |
| FloatingMachines | The recorded number of floating machines. | An integer. |
| MaxNoOfMachines | The configured maximum recorded with this state. | An integer. Nonpositive limits remain visible but do not contribute to peaks. |
| IsTracked | Whether the license was tracked at this state. | A Boolean. False must not be interpreted as observed zero usage. |
| HasValidTrackedCapacity | Whether the state is tracked and has a positive configured maximum. | A Boolean. |
| IsCurrent | Whether the point is the current state appended when End is today. | A Boolean. |
| IsBaseline | Whether an earlier state was carried to the requested range start. | A Boolean. A real change at that exact time replaces the baseline. |

### History summary

The **Summary** from Get Floating Capacity History covers the entire date range before pagination. Only tracked states with positive capacity limits contribute to its peaks.

| **Parameter** | **Description** | **Remarks** |
| - | - | - |
| HasTrackedCapacityData | Whether the full date range contains at least one state with valid tracked capacity. | A Boolean. May be true when Points is empty because the requested page is beyond the results. |
| PeakFloatingMachines | The highest recorded floating-machine count among valid states. The latest point wins ties. | An integer. Zero when HasTrackedCapacityData is false. |
| PeakConfiguredMaximum | The configured maximum at the point selected for PeakFloatingMachines. | An integer. Zero when HasTrackedCapacityData is false. |
| PeakCapacityExcess | The greatest positive difference between floating machines and the configured maximum across valid states. This peak may occur at a different point from PeakFloatingMachines. | An integer. Zero if no valid state exceeds its limit. |

### Expiry license fields

Objects in **Licenses** returned by [Get Expiring Licenses](https://help.cryptolens.io/api-reference/generated/GetExpiringLicenses.md) contain the [license identity and customer fields](https://help.cryptolens.io/api-reference/generated/model/ReportResults.md#license-identity-and-customer-fields) above, plus the following fields.

| **Parameter** | **Description** | **Remarks** |
| - | - | - |
| ExpirationUtc | The license's expiration time. | A Unix timestamp in seconds. |
| IsBlocked | Whether the license is blocked. | A Boolean. Blocked licenses are included only when IncludeBlockedLicenses is true. |

### Expiry summary

The **Summary** from Get Expiring Licenses uses the request time as its reference. It respects the owner, product/key, customer, blocked-license, and time-limited-license filters, but is independent of Window, Page, and Limit. The response's ExpiresBeforeUtc is the inclusive cutoff for the selected license list, not for these fixed summary buckets.

| **Parameter** | **Description** | **Remarks** |
| - | - | - |
| NextSevenDays | Qualifying licenses expiring after now and at or before now + 7 days. | An integer. |
| DaysEightToFourteen | Qualifying licenses expiring after now + 7 days and at or before now + 14 days. | An integer. |
| DaysFifteenToThirty | Qualifying licenses expiring after now + 14 days and at or before now + 30 days. | An integer. |
| TotalExpiring | The sum of the three nonoverlapping summary buckets. | An integer. May differ from the response's Total, which counts the selected Window. |

[View the original Web API reference](https://app.cryptolens.io/docs/api/v3/model/ReportResults)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.