The Usage Bundle can be accessed through the Usage tab 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 set of CSV files that provide select user and system activity metrics. This report is sent to Hyperscience regularly in order to allow for proper billing calculations, based on system usage and throughput. To learn more, see Automatic transmission of the Usage Report to Hyperscience.
Data reported in the CSV files includes, but is not limited to:
Application Usage
Environment Configuration
Machine Transcriptions Report
Supervision Transcriptions Report
Application Usage
Metric Name | Description | Calculation |
|---|---|---|
Date | Displays a specific period of time | Based on the parameters from the request. Days without usage will have all other columns on 0. |
Number of Submissions Created | Number of new Submission IDs created | Aggregated on Submission completion, using the Submission’s creation date and counted as 1. |
Number of Submissions Completed | Number of Submissions that had their status changed to Complete during a specific time period | Aggregated on Submission completion, using the Submission’s completion date. |
Number of Documents Created | Number of new Document IDs created | Counted as 1 for every document linked to a submission. Aggregated on Submission Completion, using the Submission’s creation date. |
Number of Documents Completed | Number of Documents that had their status changed to Complete during the specific time span. | Counted as 1 for every document linked to a submission. Aggregated on Submission completion, using the Submission’s completion date. |
Number of Pages Created | Number of submission pages linked to a submission | Aggregated on Submission completion, using the Submission’s creation date. |
Number of Pages Completed | Number of submission pages linked to a submission | Aggregated on Submission completion, using the Submission’s completion date. |
Number of Pages Matched to Structured Layout Variations Created | Number of pages on structured documents linked to a submission | Counted as 1 for every page on a structured document. Aggregated on Submission Completion, using the Submission’s creation date. |
Number of Pages Matched to Structured Layout Variations Completed | Number of pages on a structured document, linked to a completed submission | Counted as 1 for every page on structured documents, linked to a completed submission. Aggregated on Submission completion, using the Submission’s completion date. |
Number of Pages Matched to Semi-Structured Layout Variations Created | Number of pages on semi-structued documents, linked to a submission. | Counted as 1 for every page on semi-structured documents, linked to a submission. Aggregated on Submission’s completion, using the date of completion. |
Number of Pages Matched to Semi-Structured Layout Variations Completed | Number of pages on semi-structured documents, linked to a completed submission. | Counted as 1 for every page on semi-structured documents, linked to a completed submission. Aggregated on Submission completion, using the Submission’s completion date. |
Number of Pages with Fields on them Created | Number of pages with at least one field or cell on documents linked to a submission. | Counted as 1 for every page with at least one field or cell on document, linked to a submission. Aggregated on Submission completion, using the date of completion. |
Number of Pages with Fields on them Completed | Number of pages with at least one field or cell on completed or failed documents, linked to a submission. | Counted as 1 for every page with at least one field or cell on completed or failed documents, linked to a submission. |
Number of Fields Created | Number of fields for every page on documents linked to a submission | Aggregated on Submission completion, using the completion date. |
Number of Fields Completed | Number of completed fields for every page on documents linked to a submission | Always equal to Number of Fields Created. |
Number of Characters Completed | Number of characters transcribed by the machine or a human on completed and not skipped fields and cells for every page on documents linked to a submission. Note: PII wiped fields/cells are not counted; checkboxes are counted as 1 character. | Aggregated on Submission completion, using the completion date. |
Seats | Provides tracks for every login in the platform and a count of the number of users logged at least once that day. | Aggregated on User login, using the User's last login date. |
Numbers of Files Submitted | Number of files used to create the submission | Aggregated on Submission start, using the Submission's creation date. |
Number of Entries Machine Transcribed | Number of completed fields and cells transcribed by the machine for every page on documents linked to a submission | Aggregated on Submission completion, using the Submission's completion date. |
Number of Entries Manually Transcribed | Number of completed fields and cells transcribed by a human for every page on documents linked to a submission. | Aggregated on Submission completion, using the Submission's completion date. |
Number of Fields Machine Identified | Number of completed fields identified by the machine (excluding flexible extraction tasks) for every page on documents linked to a submission. | Aggregated on Submission completion, using the Submission's completion date. |
Number of Fields Manually Identified | Number of completed fields identified by a human (excluding flexible extraction tasks) for every page on documents linked to a submission | Aggregated on Submission completion, using the Submission's completion date. |
Number of Pages Classified Automatically | Number of pages linked to a submission classified by the machine | Aggregated on Submission completion, using the Submission's completion date. |
Number of Pages Classified Manually | Number of pages linked to a submission classified by a human | Aggregated on Submission completion, using the Submission's completion date. |
Number of Unique Layout Variations Matched | Number of different layouts matched to every submission page. It can be counted multiple times for the same submission if the creation date is different from completion date | Aggregated on Submission completion, using the Submission's completion date. |
Number of QA Responses on Manual Transcription | Number of QA transcription responses performed by a human for fields that were not manually supervised on structured and semi-structured documents | Aggregated on Submission completion and QA transcription response (including fields, cells for structured or semi-structured layouts), using the completion date. |
Number of QA Correct Responses on Manual Transcription | Number of correct QA transcription responses performed by a human for fields that were not manually supervised on structured and semi-structured documents | Aggregated on Submission completion and QA transcription response (including fields, cells for structured or semi-structured layouts), using the completion date. |
Number of QA Responses on System Transcription | Number of QA transcription responses for fields that were not manually supervised on structured and semi-structured documents | Aggregated on Submission completion and QA transcription response (including fields, cells for structured or semi-structured layouts), using the completion date. |
Number of QA Correct Responses on System Transcription | Number of correct QA transcription responses for fields that were not manually supervised on structured and semi-structured documents | Aggregated on Submission completion and QA transcription response (including fields, cells for structured or semi-structured layouts), using the completion date. |
Number of QA Responses on Machine Transcription | Number of QA transcription responses performed by the machine for fields that were not manually supervised on structured and semi-structured documents | Aggregated on Submission completion and QA transcription response (including fields, cells for structured or semi-structured layouts), using the completion date. |
Number of QA Correct Responses on Machine Transcription | Number of correct QA transcription responses performed by the machine for fields that were not manually supervised on structured and semi-structured documents | Aggregated on Submission completion and QA transcription response (including fields, cells for structured or semi-structured layouts), using the completion date. |
Number of QA Responses on Manual Field Identification | Number of QA field ID responses performed by a human for fields on semi-structured documents | Aggregated on Submission completion and QA Field ID response, using the date of completion. |
Number of QA Correct Responses on Manual Field Identification | Number of correct QA field ID responses performed by a human for fields on semi-structured documents | Aggregated on Submission completion and QA Field ID response, using the date of completion. |
Number of QA Responses on System Field Identification | Number of QA field ID responses for fields on semi-structured documents | Aggregated on Submission completion and QA Field ID response, using the date of completion. |
Number of QA Correct Responses on System Field Identification | Number of correct QA field ID responses for fields on semi-structured documents | Aggregated on Submission completion and QA Field ID response, using the date of completion. |
Number of QA Responses on Machine Field Identification | Number of QA field ID responses performed by the machine for fields on semi-structured documents | Aggregated on Submission completion and QA Field ID response, using the date of completion. |
Number of QA Correct Responses on Machine Field Identification | Number of correct QA field ID responses performed by the machine for fields on semi-structured documents | Aggregated on Submission completion and QA Field ID response, using the date of completion. |
Number of Incremental Fields Machine Transcribed | Number of field machine transcriptions that were automated due to finetuning that would have otherwise gone to supervision for every field on documents pages linked to a submission. | Aggregated on Submission completion, using the Submission's completion date. |
Organize Documents: Number of Tasks Performed | Number of completed Classification Supervision tasks. | Counted as 1 for every classification supervision task completed. Aggregated on Classification Supervision task response, using the task's completion date. |
Organize Documents: Number of Pages Shown in Step 1 | Number of unmatched pages from machine classification for every classification SV task completed. These are the pages shown in the classification SV tasks | Aggregated on Classification Supervision task response, using the task's completion date. |
Organize Documents: Number of Pages Categorized in Step 1 | Number of unmatched pages from machine classification that were classified by a human for every classification SV task completed | Aggregated on Classification Supervision task response, using the task's completion date. |
Organize Documents: Number of Documents Created in Step 1 | Number of documents that were created or changed (example: layout changed) by the user for every classification SV task completed | Aggregated on Classification Supervision task response, using the task's completion date. |
Organize Documents: Number of Documents Outputted in Step 1 | Number of resulting documents for every classification SV task completed | Aggregated on Classification Supervision task response, using the task's completion date. |
Organize Documents: Number of Folders Created in Step 2 | Number of resulting folders for every classification SV task completed | Aggregated on Classification Supervision task response, using the task's completion date. |
Number of Live Layout Variations | Number of live layouts that existed on the specific day | Aggregated on today's date, at the beginning of the day (00.00) |
Software Version | Shows the software version on that specific day. | Aggregated on today's date, at the beginning of the day (00.00) |
Number of Machine Match Non-Structured Pages | Number of pages classified by the machine for every non-structured page linked to a submission | Aggregated on Submission completion, using the date of completion. |
Number of Human Match Non-Structured Pages | Number of pages classified by a human for every non-structured page linked to a submission | Aggregated on Submission completion, using the date of completion. |
Number of Releases | Number of releases that existed on that day | Aggregated on today's date, at the beginning of the day (00.00) |
Number of Archived Releases | Number of archived releases that existed on that day | Aggregated on today's date, at the beginning of the day (00.00) |
Number of Layout Variations | Number of layouts that existed on that day | Aggregated on today's date, at the beginning of the day (00.00) |
Number of Archived Layouts | Number of archived layouts that existed on that day | Aggregated on today's date, at the beginning of the day (00.00) |
Number of Layout Versions | Number of layout versions that existed on that day | Aggregated on today's date, at the beginning of the day (00.00) |
Number of Live IDP Flows | Number of distinct active releases (deployed in live flows) on that day | Aggregated on today's date, at the beginning of the day (00.00) |
Number of Table Cells Created | Number of cells for every page on documents linked to a submission | Aggregated on Submission completion, using the date of completion. |
Number of Table Cells Completed | Number of cells for every page on documents linked to a submission | Always equal to the Number of Table Cells created. |
Number of Table Cells Machine Identified | Number of completed cells identified by the machine (excluding flexible extraction tasks) for every page on documents linked to a submission | Aggregated on Submission completion, using the date of completion. |
Number of Table Cells Manually Identified | Number of completed cells identified by a human (excluding flexible extraction tasks) for every page on documents linked to a submission | Aggregated on Classification QA consensus reached, using the Submission's completion date. |
Number of QA Responses on Manual Non-Structured Classification Pages | Number of classification QA responses performed by a human for non-structured documents linked to a submission | Aggregated on Classification QA consensus reached, using the Submission's completion date. |
Number of QA Correct Responses on Manual Non-Structured Classification Pages | Number of correct classification QA responses performed by a human for non-structured documents linked to a submission | Aggregated on Classification QA consensus reached, using the Submission's completion date. |
Number of QA Pages Classified on System Non-Structured Classification pages. | Number of QA classified pages for non-structured documents linked to a submission | Aggregated on Classification QA consensus reached, using the Submission's completion date. |
Number of QA Pages Classified on System Non-Structured Classification Pages | Number of correct QA classified pages for non-structured documents linked to a submission | Aggregated on Classification QA consensus reached, using the Submission's completion date. |
Number of QA Responses on Machine Non-Structured Classification Pages | Number of classification QA responses performed by the machine for non-structured documents linked to a submission | Aggregated on Classification QA consensus reached, using the Submission's completion date. |
Number of QA Correct Responses on Machine Non-Structured Classification Pages | Number of correct classification QA responses performed by the machine for non-structured documents linked to a submission | Aggregated on Classification QA consensus reached, using the Submission's completion date. |
Number of Fields Extracted in Flexible Extraction | Number of completed fields transcribed on flexible extraction for every page on documents linked to a submission | Aggregated on Submission completion, using the date of completion. |
Number of Table Cells Extracted in Flexible Extraction | Number of completed cells transcribed on flexible extraction for every page on documents linked to a submission | Aggregated on Submission completion, using the date of completion. |
Number of Fields Extracted in Custom Supervision | Number of completed fields transcribed on custom supervision for every page on documents linked to a submission | Aggregated on Submission completion, using the date of completion. |
Number of Table Cells Extracted in Custom Supervision | Number of completed cells transcribed on custom supervision for every page on documents linked to a submission | Aggregated on Submission completion, using the date of completion. |
Product analytics
The Usage Bundle 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 Bundle 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 Bundle to Hyperscience
This feature applies to on-premise deployments that are connected to the internet.
The system automatically transmits your Usage Bundle 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 the Usage Bundle. To learn more about the configuration options available for automatic transmissions, see Automatic Transmissions of the Usage Bundle.