/
Usage Container
/
Usage API

ASR Usage Container REST API

The ASR Usage Container collects usage data from ASR Containers. This data contains no sensitive information and is used by Speechmatics only for billing and improving product functionality. The following REST API can be used to export this data to be forwarded to Speechmatics.

Version: 0.2.0

Contact information:
support@speechmatics.com

Base URL: /v1

Scheme: HTTP

Port: 8000

/export

GET

Summary:

Export usage data. By default, all data is included. Use the query parameters to enforce a date range. It is possible to examine the contents of the exported data, but please do not modify it or the data will be rejected by Speechmatics, and will need to be regenerated The format of exported data can be specified in the Accept header, which defaults to application/gzip. An uncompressed version can be requested with application/json. You must send data to Speechmatics in .gz format

Parameters
NameLocated inDescriptionRequiredSchema
sincequeryOnly include data dated after (inclusive) the given time. This is a timestamp in ISO-8601 format: YYYY-MM-DDTHH:MM:SSZ.NodateTime
untilqueryOnly include data dated before (inclusive) the given time. This is a timestamp in ISO-8601 format: YYYY-MM-DDTHH:MM:SSZ.NodateTime
Responses
CodeDescription
200OK
400Bad Request
500Internal Server Error