Key Usage Summary
A key usage summary contains lifetime aggregate usage metrics for a license key.
Key usage summaries are updated asynchronously, so very recent activity may not appear immediately. They are lifetime key-level totals and can include license keys that are excluded from daily overview analytics.
Counters with names such as ActivationSuccess are based on Web API log state codes. The first two digits identify the method group, and the third digit identifies success (1) or failure (2). For example, ActivationSuccess counts activation states 2010-2019, while ActivationFailed counts activation states 2020-2029. Exact outcome counters map to the specific state codes listed below. See Web API Log state codes for the general format.
Structure
| Parameter | Description | Remarks |
| Id | A unique identifier of this summary. | An integer |
| ProductId | The id of the product. | An integer |
| KeyId | The license key ID. | An integer |
| Key | The license key string, if the key still exists. | A string |
| TotalRequests, TotalSuccessful, TotalFailed | Lifetime request totals grouped by success and failure. | Integers |
| FirstSeenUtc | The first time this key appeared in usage analytics. | Unix timestamp (integer) |
| LastSeenUtc | The most recent time this key appeared in usage analytics. | Unix timestamp (integer) |
| ActivationSuccess, ActivationFailed | Activation request counts grouped by success and failure. | Integers |
| DeactivationSuccess, DeactivationFloating | Deactivation request counts. | Integers |
| ActivationNewMachine, ActivationTrial, ActivationFloating, ActivationDeviceLimit | Specific activation outcome counts. | Integers |
| TrialKeyGenerated, TrialKeyReused, TrialKeyCreateError | Trial key generation counts. | Integers |
| DataObjectOps, DataObjectIncrementInt, DataObjectDecrementInt, DataObjectSetInt, DataObjectSetString | Data object operation counts for this key. | Integers |
State code mapping
| Counter | State codes counted |
| TotalSuccessful, TotalFailed | Any state with third digit 1; any state with third digit 2. |
| ActivationSuccess, ActivationFailed | 2010-2019; 2020-2029. |
| DeactivationSuccess, DeactivationFloating | 6010-6019; 6011. |
| ActivationNewMachine, ActivationTrial | 2012; 2013. |
| ActivationFloating | 2014 and 2015. |
| ActivationDeviceLimit | 2022 and 2024. |
| TrialKeyGenerated, TrialKeyReused, TrialKeyCreateError | 3011; 3012; 3021. |
| DataObjectOps | 8010-8019. |
| DataObjectIncrementInt, DataObjectDecrementInt, DataObjectSetInt, DataObjectSetString | 8014; 8015; 8016; 8017. |