STT recognition sessions (rollup, one row per session)

get

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

Per-session STT recognition report served from ClickHouse: the raw STT lifecycle event stream is rolled up into one row per session. A single endpoint serves all three hierarchically related session levels (linked by id: providerSessionId -> fallbackSessionId -> streamingSessionId) via the level query parameter (default streaming). Each level rolls up ONLY its own events. Billing fields (price, tariff, billedUnit, billedValue, billedCount) exist only on the provider level (level=provider); the streaming level instead carries child counters (fallbackSessionCount, providerSessionCount, providersUsedCount). The returned item is a superset of all levels' fields — only the requested level's fields are populated.

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.

level

string

enum

Defaults to streaming

Which session level to roll up. streaming (default) = top level with child counters; fallback = middle level; provider = bottom level (the only billing carrier).

Allowed:

status

string

Filter by the rolled-up session status (post-aggregate).

provider

string

Filter by STT provider name (provider level).

language

string

enum

Output locale for report column headers (ru/en). This is the localisation locale for the exported column headers, NOT a data filter — to filter rows by the recognition language use recognitionLanguage. Any other value collapses to en.

Allowed:

recognitionLanguage

string

Filter by recognition language (data filter). Short code, e.g. ru. Available on level=fallback and level=provider only; on level=streaming the request is rejected with 400 (the rollup has no language column there). Input is normalised to the 2-letter prefix, so ru / ru-RU / ru_RU / RU all match ru.

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.

periodBy

string

enum

Defaults to createdAt

Which timestamp the [from, to] range filters on. createdAt (default) and startedAt map to the session create time; updatedAt and finishedAt map to the session finish time.

Allowed:

fields

string

Comma-separated list of fields to return. Superset across levels: companyId, streamingSessionId, fallbackSessionId, providerSessionId, status, codec, language, provider, sourceId, sourceService, sourceType, createdAt, finishedAt, lastEventAt, eventsCount, error, fallbackSessionCount, providerSessionCount, providersUsedCount, sttId, requiredSttId, usedSttId, priority, finalResultTimeout, speechTimeout, silenceTimeout, streamOffset, totalDuration, noVoiceDuration, startTime, endTime, text, billedUnit, billedValue, billedCount, price, tariff. Only the requested level's fields are populated. The heavy text transcript is omitted unless explicitly requested.

sort

string

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

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 request (InvalidArgumentException). Returned when: an unknown level is passed; the provider filter is used on a level other than provider; the recognitionLanguage filter is used on level=streaming (language_state exists only on the fallback/provider rollups); an unknown periodBy/sort field is passed; or the [from, to] window exceeds the configured maximum span.

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