usage

URL: http://vblaze_name:17171/usage

Example Response:
{
    "eng-us:autodealership": [
        153.37869999999998,
        3727
    ],
    "eng-us:callcenter": [
        159.3873,
        1440
    ],
    "eng-us:healthcare": [
        2.9419,
        54
    ],
    "spa-co:callcenter": [
        3.5089,
        118
    ],
	"total": [
        319.2167999999,
        5339
    ]
}

Explanation:

The sample response contains usage information of language models. Each model includes an array with two values. The first value indicates the number of audio hours transcribed with that model. The second value indicates the number of streams that have used the model.

Filtered /usage queries

Usage requests can be filtered by tag, key, model, or license by including the object you're looking for as part of the endpoint path. For example, the following request limits the usage response to only return usage data for the eng-us:callcenter model:
curl --request GET 'https://vblaze_name:17171/usage/eng-us:callcenter'

usagetags

URL: http://vblaze_name:17171/usagetags

Example Response:
{
    "": [
        0.9358,
        511
    ],
    "DG": [
        0.0024,
        2
    ],
    "*GR": [
        0.009,
        5
    ],
    "total": [
        0.9779,
        535
    ],
    "*G": [
        0.0307,
        17
    ]
}

Explanation:

The response sample contains characters that represent the usage of standard transcription parameters. The first value indicates the number of audio hours transcribed, and the second value indicates the number of streams. The following table details the characters and the transcription parameters they are mapped to.
CharacterAssociated transcription parameter
Ascrubaudio
aagentid
Ddiarize
Eemotion
Ggender
Hhints
Llid
Mmusic
Ssentiment
Rrealtime
Tscrubtext
*notext

usagemodel

URL: http://vblaze_name:17171/usagemodel

Example Response:
{
    "eng-us:autodealership": [
        153.37869999999998,
        3727
    ],
    "eng-us:callcenter": [
        159.3873,
        1440
    ],
    "eng-us:healthcare": [
        2.9419,
        54
    ],
    "spa-co:callcenter": [
        3.5089,
        118
    ],
	"total": [
        319.2167999999,
        5339
    ]
}

Explanation:

The response sample contains the usage information of each model. Each model includes an array with two values. The first value indicates the number of audio hours transcribed with that model. The second value indicates the number of streams that have used the model.

usagekeys

URL: http://vblaze_name:17171/usagekeys

Example Response:
[
    "billing",
    "model",
    "tags"
]

Explanation:

The response sample lists the usage keys that are tracked. The default keys are billing, model, and tags.

usagefull

URL: http://vblaze_name:17171/usagefull

Example Response:
{
    "": {
        "total": [
            0.9779,
            535
        ],
        "eng-us:callcenter": {
            "": [
                0.9358,
                511
            ],
            "*GR": [
                0.009,
                5
            ],
            "total": [
                0.9629,
                526
            ],
            "*G": [
                0.0181,
                10
            ],
            "key": "tags"
        },
        "key": "model",
        "eng-us:callcenter-xa": {
            "DG": [
                0.0024,
                2
            ],
            "total": [
                0.015,
                9
            ],
            "*G": [
                0.0126,
                7
            ],
            "key": "tags"
        }
    },
    "total": [
        0.9779,
        535
    ],
    "key": "billing"
}

Explanation:

The response sample contains a nested JSON containing detailed usage information sorted by the billing, model, and tags keys.

usagelicense

URL: http://vblaze_name:17171/usagelicense

Example Response:
{
	"model=eng-us:callcenter,tags=*G": [
        0.0181,
        10
    ],
    "model=eng-us:callcenter": [
        0.9358,
        511
    ],
    "model=eng-us:callcenter,tags=*GR": [
        0.009,
        5
    ]
}

Explanation:

Responses from /usagelicense sort usage data by license when more than one license is in use. For single licenses, the response is identical to /usageraw.

usageraw

URL: http://vblaze_name:17171/usageraw

Example Response:
{"model=eng-us:callcenter,tags=*G":[0.0181,10],"model=eng-us:callcenter":[0.9358,511],"model=eng-us:callcenter,tags=*GR":[0.009,5]}

Explanation:

The sample response contains a more concise version of /usagefull. It does not have nested dictionaries, and the format is provided as an alternative that may be preferable in some cases.