App usage tracking

If your application lets users enter their own Speechmatics API key, app usage tracking gives you aggregated analytics about your users' usage levels, including the number of unique users, hours processed, and languages used.

You add an app ID to each request with the sm-app query parameter, and Speechmatics aggregates usage against it.

Contact Support to enable this feature before using it.

Availability

App usage tracking is available for pre-recorded and streaming transcription with the Standard, Enhanced, and Melia 1 models. See Feature availability.

Add an app ID to a request

Add the sm-app query parameter when starting a job:

APP_ID="YourAppID"
API_KEY="YOUR_API_KEY"
PATH_TO_FILE="example.wav"

# sm-app attributes this job's usage to your application
curl -L -X POST "https://eu1.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": { "model": "enhanced","language": "en" }}'

Add the sm-app query parameter to the connection string when starting a session:

# sm-app attributes this session's usage to your application
wss://eu.rt.speechmatics.com/v2?sm-app=YourAppID