Skip to main content

Virtual Appliance Usage Reporting

The Appliance offers two usage modes for you to report your transcription usage.

  • online (default) is the most convenient way to report on usage. This works by automatically sending periodic HTTPS requests to Speechmatics over the course of a transcription session.
  • offline uses a Container inside the Appliance to collect usage locally and can be used if you have specific restrictions preventing connection to the Internet. This produces an output which needs to be sent to Speechmatics via email.

Setting the Usage Mode​

The usage mode can be set via the Management API

curl -L -u admin:admin -X 'POST' \
  "http://${APPLIANCE_HOST}/v2/management/usagereporting" \
  -d '{"mode": "offline"}'

where mode is one of offline | online

Online Mode​

Transcription:BatchDeployments:Appliance

When the usage mode is set to online, usage will be periodically sent via HTTPS request to Speechmatics over the course of a transcription session. Information recorded includes the job configuration, the duration of transcription, and the amount of audio being transcribed.

For more info see Automatic Usage Reporting

info

We will never send customer audio data over the network. See What Data Do We Record for a full description of what information will be recorded.

Offline Mode​

Transcription:BatchDeployments:Appliance

When the usage mode is set to offline, usage will be collected via a Container inside the appliance, the data collected by this Container will need to be sent to Speechmatics via email billing-reporting@speechmatics.com.

Workflow​

The following workflow is recommended:

  • The user downloads and runs one or more of the Batch Virtual Appliances
  • Before running any jobs, the user sets the usage mode to offline see above
  • At intervals of no more than a calendar month, the user will extract usage data processed in that interval from each running Appliance via the Management API, see below
  • The user will then send this data to a designated Speechmatics email address at (billing-reporting@speechmatics.com).

Exporting Usage Data​

info

The exported data must not be modified in any way before sending to Speechmatics. Speechmatics will request a new unmodified data export if it is found that data has been altered.

Data is retained in the appliance for 90 days, after which point it is purged. Exported data needs to be sent to via email to billing-reporting@speechmatics.com.

A zip of the usage data can be retrieved via the Management API

curl -X 'GET' \
  "http://${APPLIANCE_HOST}/v1/export?since={start_time}&until={end_time}" \
  -H 'accept: application/gzip'

Where start_time and end_time are inclusive and are timestamps in the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

To remain under the 25MB email attachment limit, we recommend changing start_time and end_time to chunk exports into 25MB files (usually around 10,000 batch jobs).

Data is exported in compressed json.gz format. All files must be sent in this format to Speechmatics. The name of the file does not matter.

For more details see Offline Usage Reporting