Sign in

v4

latestOpenAPI 3.0.02026-08-049285219.1 KB
Channels

Get captioned minutes analytics for a channel

Only available when the Captions & Translations feature is enabled on organization level. The 'start' and 'end' dates are always interpreted as UTC; timezone and UTC offset options are not supported.

get/channels/{id}/analytics/captions/captioned-minutes

Path parameters

idstring required

Channel ID

Channel ID

Query parameters

startstring required

Start date for the analytics period in 'YYYY-MM-DD' format. Always interpreted as UTC; timezone and UTC offset options are not supported for these analytics.

Start date for the analytics period in 'YYYY-MM-DD' format. Always interpreted as UTC; timezone and UTC offset options are not supported for these analytics.

endstring required

End date for the analytics period in 'YYYY-MM-DD' format. Must be equal to or later than 'start'. Always interpreted as UTC; timezone and UTC offset options are not supported for these analytics.

End date for the analytics period in 'YYYY-MM-DD' format. Must be equal to or later than 'start'. Always interpreted as UTC; timezone and UTC offset options are not supported for these analytics.

resolution'day' | 'month'

Time resolution for the analytics data. Defaults to 'day'. For 'day', the difference between 'start' and 'end' can be at most 1000 days.

Time resolution for the analytics data. Defaults to 'day'. For 'day', the difference between 'start' and 'end' can be at most 1000 days.

groupBy'channel' | 'ingest'

Group results by channel or ingest. Defaults to 'channel'.

Group results by channel or ingest. Defaults to 'channel'.

ingestIdsstring

Comma-separated list of ingest IDs to filter by

Comma-separated list of ingest IDs to filter by

Response

Captioned minutes analytics data