The Usage Report can be accessed on the Usage page of the application (Reporting > Usage). In the drop-down list, select from the available date ranges to download the data for that period:
Week to Date
Month to Date
Year to Date
Select Date Range
This reporting feature allows the user to generate and download a CSV report of select user and system activity metrics. You will need to send this report to your Hyperscience representative on a regular basis in order to allow for proper billing calculations, based on system usage and throughput.
Data reported in the CSV file includes:
Application Usage
Environment Configuration
Machine Transcriptions Report
Supervision Transcriptions Report
Product analytics
The Usage Report also includes a product_analytics folder, which contains data aggregated, anonymized data about your organization's use of Hyperscience. Product analytics data is captured in several CSV files and includes information about flows, application settings, and user actions. It does not include personally identifiable information (PII).
The following data points are included in the product_analytics CSVs. We do not collect any information about the user's identity as part of these data points.
A user loads a page in the application (does not include pages in the Submissions section).
A user logs in to Hyperscience.
A user logs out of Hyperscience.
A user sends a request to one of our API endpoints.
A user clicks Perform Tasks in the Perform Tasks dialog box.
A user clicks Confirm after saving changes they've made to a section of the application settings.
A user imports a settings file.
A user exports a settings file.
While we don’t require product analytics data to complete our billing calculations, sharing this data with Hyperscience will allow us to make more informed decisions about product improvements. We do not collect this data automatically.
Infrastructure metrics
The Usage Report includes the following metrics related to system infrastructure:
database — Identifies the database vendor and version being used.
system — Reports the type and version of the operating system.
Kubernetes — Specifies the version of Kubernetes deployed.
helm-chart — Indicates the version of the Helm chart used for deployment.
These metrics are located in the infrastructure.csv file in the product _analytics folder within the downloaded bundle.
Automatic transmission of the Usage Report to Hyperscience
This feature applies to on-premise deployments that are connected to the internet.
The system automatically transmits your Usage Report to Hyperscience on a daily basis. Each report contains data from the past seven days, and all sensitive information (e.g., proxy credentials) is redacted before the report is sent. This automatic transmission of data is required contractually and cannot be disabled without making alternate arrangements with Hyperscience.
Configuration
Depending on your organization’s security measures, you may need to create a proxy or configure your firewall to allow the automatic transmission of Usage Reports. To learn more about the configuration options available for automatic transmissions, see Automatic Transmissions of the Usage Report.