Skip to main content

Tracking

Transcription:BatchDeployments:SaaSVirtual Appliance

Job tracking​

Tracking allows you to attach your own metadata to a job, which can be used for tracking the job through your own management workflow.

The tracking information will be returned when you check job status, or get the transcript for a transcription job.

The tracking object can contain the following properties:

  • title - The title of the job
  • reference - The reference used on your system
  • tags - An array of strings
  • details - A JSON object which is defined by your system. There is currently no limit to the size of this object

For example:

{
  "type": "transcription",
  "transcription_config": {
    "language": "en"
  },
  "tracking": {
    "title": "ACME Q12018 Statement",
    "reference": "/data/clients/ACME/statements/segs/2018Q1-seg8",
    "tags": [
      "quick-review",
      "segment"
    ],
    "details": {
      "user_type": "agent",
      "client": {
        "name": "ACME Corp",
        "type": "enterprise"
        },
      "seg_start": 963.201,
      "seg_end": 1091.481
    }
  }
}

App analytics​

Transcription:BatchReal-TimeDeployments:SaaS

If your application allows users to enter their own Speechmatics API key, Speechmatics can offer you aggregated analytics about your users' usage levels. This includes the number of unique users, hours processed, languages used, and more.

Please reach out to Support to get set up.

Once set up, simply use the sm-app query parameter when starting a job. For example:
    APP_ID="YourAppID"
    API_KEY="YOUR_API_KEY"
    PATH_TO_FILE="example.wav"

    curl -L -X POST "https://asr.api.speechmatics.com/v2/jobs/?sm-app=${APP_ID}" \
        -H "Authorization: Bearer ${API_KEY}" \
        -F data_file=@${PATH_TO_FILE} \
        -F config='{"type": "transcription","transcription_config": { "language": "en" }}'