STT recognition session metrics

get

https://analyse.twin24.ai/api/v1/statistics/file/stt/metrics

Returns data from the FILE service about speech-to-text recognition session lifecycle events. One wide stream holds all event types for the three hierarchically related session kinds (linked by id: providerSessionId -> fallbackSessionId -> streamingSessionId): StreamingSession (listens to the audio stream), FallbackSession (reservation), and ProviderSession (concrete provider, the only billing carrier). Billing fields (price, tariff, billedUnit, billedValue) are populated only on the SttProviderSessionBilled event.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

from

string

^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+[0-9]{2}:[0-9]{2}$

The start date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

string

^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+[0-9]{2}:[0-9]{2}$

The end date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

companyId

integer

The company identifier filter.

eventName

string

enum

Filter by STT session event type.

provider

string

Filter by STT provider name.

sttId

string

^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$

Filter by STT configuration UUID.

sourceService

string

enum

Filter by source service name.

Allowed:

sourceType

string

enum

Filter by source type.

Allowed:

streamingSessionId

string

^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$

Filter by streaming session UUID.

fallbackSessionId

string

^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$

Filter by fallback session UUID.

providerSessionId

string

^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$

Filter by provider session UUID.

fields

string

Comma-separated list of fields to return. Available fields: id, eventName, eventTimestamp, companyId, streamingSessionId, fallbackSessionId, providerSessionId, status, codec, language, provider, sourceId, sourceService, sourceType, sttId, requiredSttId, usedSttId, priority, totalDuration, noVoiceDuration, startTime, endTime, streamOffset, finalResultTimeout, speechTimeout, silenceTimeout, billedUnit, billedValue, price, tariff, text, error.

sort

string

Sort field and direction. Each sort field can have a special prefix indicating the desired sort order: + (ascending, default) or - (descending).

limit

integer

Defaults to 10

Maxium number of returning records.

offset

integer

Starting point to return records from a result set.

page

integer

Page number, used to paginate over all records.

timezone

integer

Timezone offset in minutes from UTC.

withoutCount

boolean

Defaults to false

Determines whether to return the total number of records.

withoutItems

boolean

Defaults to false

Determines whether to return the record list.

offsetField

string

Timestamp field name used for cursor-based (keyset) pagination.

offsetValue

string

Timestamp anchor value for cursor-based (keyset) pagination.

output

string

enum

Determines the output format. CSV_EXCEL format includes UTF-8 BOM and semicolon delimiter for better Excel compatibility.

Allowed:

Responses

400

Invalid input parameters

401

User is not authenticated

403

Invalid user permissions

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

5XXUnexpected error