Fields and Metrics
The Token Flex Usage Data API presents usage data through Fields and Metrics. A Field is simply an attribute of a set of usage. A Metric is calculated from the provided Fields.
For example, user John could have used two products in January. In this example, John and January are the Fields userName and usageMonth respectively. The calculated value two is the metric uniqueProducts, given the specified userName and usageMonth.
Conceptually, Metrics are measures calculated over the grouping of Fields.
General Fields
General fields applicable for all usage categories.
productLineCode Product line code (PLC) | ACD |
productName Product name | Autocad |
userName Username (NT ID or email) | john42 |
usageDate Date of usage | 2014-01-18 |
usageMonth Usage month of usage (day always 01) | 2014-01-01 |
contractYear Contract year the usage falls under | 1 |
usageCategory Usage type (see below) | DESKTOP_PRODUCT |
chargedItemID* ID for transaction/session | RXHKL8CZRMES |
customFieldX User provided custom field (X: 1-10) | GEO |
* These fields are transactional/session level attributes and can only be used when exporting.
Desktop Fields
Fields specific to DESKTOP_PRODUCT usage.
chargeCategory* Charging type (see below) | FREE |
sessionStartDate* Datetime of captured usage start | 2018-03-01T16:24:53 |
sessionEndDate* Datetime of captured usage end | 2018-03-01T17:24:53 |
productVersion Product version | 2018 |
productFeatureCode Product feature code (PFC) | 85730ACD_2018_0F |
machineName Machine name | MyMachine |
licenseServerName License server machine name | MyLicSvr |
licenseServerTimeZoneOffset* License server time zone offset | -8:00 |
usageType License type (Normal or Borrowed) | Borrowed |
* These fields are transactional/session level attributes and can only be used when exporting.
Cloud Product Fields
Fields specific to CLOUD_PRODUCT usage.
chargeCategory* Charging type (see below) | FREE |
hubId* ID for hub | urn:adsk.plm:tenant:MyHub |
hubName* Hub name | MyHub |
projectId* ID for project | urn:adsk.workspace:project:feb5c975-e2fa-43dd-96ab-2b445dc4f312 |
projectName* Project name | MyProject |
* These fields are transactional/session level attributes and can only be used when exporting.
Cloud Service Fields
Fields specific to CLOUD_SERVICE usage.
jobStatus* Job status | Success |
chargeCategory* Charging type (see below) | FREE |
* These fields are transactional/session level attributes and can only be used when exporting.
Adjustment/Consumption Fields
Fields specific to MANUAL_ADJUSTMENT and MANUAL_CONSUMPTION.
transactionDate* Adjustment date | 2014-01-18 |
reasonType Adjustment reason | Off network |
reasonComment* Adjustment comment | ACD promotion |
tokenPool** Token pool for usage (CY or MY) | CY |
* These fields are transactional/session level attributes and can only be used when exporting. ** These fields are only applicable for MANUAL_ADJUSTMENT
Metrics
uniqueProducts Distinct count of products | 42 |
uniqueUsers Distinct count of users | 56533 |
tokensConsumed Sum of tokens consumed | 62617 |
usageMinutes Sum of duration used in minutes | 63521 |
usageHours Sum of duration used in hours | 100 |
useCount Count of charged events | 761 |
Charge Category
Value | Description |
---|---|
CASUAL | Usage not charged due to being under the chargeable contractual duration for use |
INCREMENTAL | Usage charged a differential rate due to existing charged use for a similar/lesser product |
CHARGED | Charged usage |
FREE | Free usage for sessions after charging has already occurred for that day |
Usage Category
Value | Description |
---|---|
DESKTOP_PRODUCT | Desktop products such as Autocad and Revit |
CLOUD_PRODUCT | Cloud products such as Collaboration for Revit and Fusion360 |
CLOUD_SERVICE | Cloud services such as Rendering and Photo-to-3D |
MANUAL_ADJUSTMENT | Direct adjustments to token balance |
MANUAL_CONSUMPTION | Manually entered product consumption amounts (such as for Off-Network usage) |