Reporting Data API field reference

To choose which fields to request from an OpenLM Reporting Data API query, use the lists on this page. For the queries themselves and their parameters, see Query the Reporting Data API.

Main report query fields

Select these fields inside nodes { }:

licenseUsage

usage_id (Long), license_id (Int), server_id (Int), package_id (Int), feature_name (String), vendor (String), lic_inv_vendor (String), product_name (String), license_type (String), lic_inv_type (String), license_version (String), lic_inv_version (String), is_token_based (String), num_of_licenses (Int), borrowed (Int), host_id (String), host_name (String), user_id (String), user_name (String), start_time_utc (DateTime), end_time_utc (DateTime), duration (Float), idle_time (Float), ts_ms (DateTime)

licenseDenials

denial_id (Int), additional_key (String), denial_category (String), denial_date (DateTime), denial_type (String), error_message (String), feature_name (String), license_id (Int), license_type (String), major_err (Int), minor_err (Int), num_of_licenses (Int), product_name (String), project_id (String), server_id (Int), status (String), transaction_id (String), ts_ms (DateTime), user_id (String), user_name (String), vendor (String), workstation (String), host_name (String)

sessionDetails

session_id (String), agent_status (Int), customer_id (String), dll_name (String), host_name (String), monitoring_id (Int), process_id (String), process_name (String), session_duration_in_min (Float), session_end_time (DateTime), session_start_time (DateTime), shutdown_reason (String), total_idle_time_in_min (Float), transaction_id (String), user_id (String), user_name (String), version (String), ts_ms (DateTime)

touchpointDetails

id (String), customer_id (String), event_date_time (DateTime), event_type (Int), event_type_desc (String), found_url (String), page_title (String), touchpoint_event_source (String), ts_ms (DateTime), user_id (String), user_name (String), website_type (String), workstation (String), local_host (String), main_domain (String), sub_domain (String)

dongleMonitoring

monitoring_id (String), agent_status (Int), blacklisted_when_connected_or_disconnected (String), customer_id (String), device_connected_date_time (DateTime), device_description (String), device_disconnected_date_time (DateTime), device_identifier (String), device_name (String), host_name (String), last_update_date_time (DateTime), manufacturer (String), serial_number (String), user_name (String), vendor (String), user_id (String), ts_ms (DateTime)

projectData

project_id (String), end_date_utc (DateTime), group_id (String), group_name (String), is_enabled (String), percent_done (Int), priority (String), project_name (String), source (String), start_date_utc (DateTime), ts_ms (DateTime), user_id (String), user_name (String)

devices

The devices field names are camelCase, unlike the snake_case fields of the other reports.

tenantId (String), userId (String), deviceIdentifier (String), deviceName (String), deviceDescription (String), manufacturer (String), deviceConnectedDateTime (DateTime), lastUpdateDateTime (DateTime), deviceDisconnectedDateTime (DateTime), userName (String), hostName (String), blacklistedWhenConnectedOrDisconnected (Boolean), serialNumber (String), agentStatus (AgentStatus enum), vendor (String)

utilizationByFeature / utilizationByVendor (Cloud only)

license_id (Int), feature_name (String), software_name (String), license_type (String), vendor (String), product_name (String), start_date_utc (DateTime), hour (Int), quantity (Int), max_concurrent_usage (Long), min_concurrent_usage (Long), avg_concurrent_usage (Float), additional_key (String), ts_ms (DateTime), server_id (Int), license_version (String), usage_percent (Decimal)

procuredItems (Cloud only)

issued_date (DateTime), start_date (DateTime), expiration_date (DateTime), asset_info (String), additional_key (String), feature_name (String), license_type (String), product_name (String), server_id (Int), vendor (String), software_name (String), quantity (Int), license_version (String), allocated (Long), total_available (Long), util_percent (Decimal), ts_ms (DateTime)

inventoryItems (Cloud only)

license_id (Int), feature_name (String), vendor (String), product_name (String), license_type (String), is_token_based (String), quantity (Int), package_id (Int), package_name (String), software_name (String), license_version (String), server_id (Int)

This query returns the first 25 license usage records:

{
  licenseUsage(first: 25) {
    totalCount
    pageInfo { hasNextPage endCursor }
    nodes {
      user_name
      feature_name
      vendor
      start_time_utc
    }
  }
}

Count queries (no fields)

licenseUsageActiveLicenseCount, licenseUsageHostRunningCount, licenseDenialsDenialCountInLast24Hours, and licenseDenialsNewAlertsCountIn24Hours each return a single Int. Request the query name:

{ licenseUsageActiveLicenseCount }

Value types for filter-value queries

Filter-value queries have no field names to select. items returns the raw values directly. The following list gives the type of each value:

• String values: all License Usage, License Denials, Project Data, Device, and Touchpoint username and workstation filters, plus the Session Details user, workstation, process, dependency, customer, reason, and version filters, and the Dongle Monitoring device name, description, manufacturer, username, host name, and blacklisted filters.
• Float values: sessionDetailsIdleTimeFilterValues and sessionDetailsSessionFilterValues
• Int values: sessionDetailsAgentStatusFilterValues and dongleMonitoringAgentStatusFilterValues
• DateTime values: sessionDetailsSessionEndTimeHolidaysFilterValues, sessionDetailsSessionEndTimeWeekdaysFilterValues, and touchpointDetailsEventDateTimeFilterValues

This query returns the vendor filter values that match an empty search term:

{
  licenseUsageVendorFilterValues(searchTerm: "", take: 20) {
    totalCount
    pageInfo { hasNextPage }
    items
  }
}

Widget query fields (Cloud only)

For widget queries, select the fields directly:

topDeniedFeatures

feature_name (String), vendor (String), product_name (String), license_type (String), denial_type (String), denial_category (String), denial_count (Long), last_denial_date (DateTime)

topDeniedUsers

user_id (String), user_name (String), department (String), email (String), denial_count (Long), unique_denied_features (Long), last_denial_date (DateTime)

topMostUsedFeatures / topLeastUsedFeatures

feature_name (String), software_name (String), vendor (String), license_type (String), package_id (Int), total_duration_days (Float), unique_users (Long), last_used_utc (DateTime)

topLongestSessions

usage_id (Int), feature_name (String), software_name (String), vendor (String), package_id (Int), server_name (String), user_id (String), user_name (String), first_name (String), last_name (String), department (String), group_name (String), start_time_utc (DateTime), end_time_utc (DateTime), date (DateTime), duration_days (Float), idle_time_hours (Float), is_active (Boolean)

topIdleSessions

usage_id (Int), feature_name (String), software_name (String), vendor (String), package_id (Int), server_name (String), user_id (String), user_name (String), first_name (String), last_name (String), department (String), group_name (String), start_time_utc (DateTime), end_time_utc (DateTime), duration_days (Float), idle_time_hours (Float)

topProductNames

product_name (String), vendor (String), session_count (Long), total_duration_days (Float), unique_users (Long), unique_features (Long)

topVendorNames

vendor (String), package_id (Int), session_count (Long), total_duration_days (Float), unique_users (Long), unique_features (Long), unique_products (Long)

topMostActiveUsers / topLeastActiveUsers

user_id (String), package_id (Int), user_name (String), first_name (String), last_name (String), department (String), email (String), mobile_phone (String), group_name (String), session_count (Long), total_duration_days (Float), total_idle_time_hours (Float), unique_features (Long), last_seen_utc (DateTime)

activeUsersReport

usage_id (Int), user_id (String), user_name (String), group_name (String), feature_name (String), software_name (String), server_name (String), host_id (String), num_of_licenses (Int), borrowed (Int), idle_time_hours (Float), start_time_utc (DateTime), date (DateTime), running_days (Long), running_hours (Long), running_minutes (Long), running_seconds (Long), borrowed_text (String), session_length_category (String)

licenseServerStatus

transaction_id (String), server_id (Int), server_name (String), license_manager_type (String), host_name (String), server_port (Int), host_status (String), server_status (String), update_date_utc (DateTime), ts_ms (DateTime), status_description (String)

hostAvailability

host_name (String), server_port (Int), host_status (String), server_name (String), vendor (String), license_manager_type (String), last_seen_utc (DateTime)

This query returns the five most denied features:

{
  topDeniedFeatures(limit: 5) {
    feature_name
    vendor
    denial_count
    last_denial_date
  }
}

Related pages

For more information, see these pages:

• Query the Reporting Data API: endpoints, parameters, and the query catalog.
• Authenticate to the Reporting Data API: get a Bearer token first.