This documentation is for reference only. We are no longer onboarding new customers to Programmable Video. Existing customers can continue to use the product until December 5, 2026.
We recommend migrating your application to the API provided by our preferred video partner, Zoom. We've prepared this migration guide to assist you in minimizing any service disruption.
The Video Log Analyzer REST API provides access to data generated by Programmable Video rooms and participants. Video Logs are available for two days for WebRTC Go rooms, and seven days for all other room types. Summarization and propagation of data may take up to thirty minutes following the end of a room, but most logs are available within ten minutes.
Video Log Analyzer data is available under the following base URL. The REST API is served over HTTPS; unencrypted HTTP is not supported.
_10https://insights.twilio.com/v1/Video/Rooms
HTTP requests to the REST API are protected with HTTP Basic authentication. You will use your Twilio account SID as the username and your auth token as the password for HTTP Basic authentication. You can find your account SID and auth token on the console home page. To learn more about how Twilio handles authentication, please refer to our security documentation.
The Rooms list provides a queryable list of Programmable Video Rooms. By default only Rooms completed in the last 24 hours are listed. Use the CreatedBefore and CreatedAfter parameters to query a larger date range.
_10GET https://insights.twilio.com/v1/Video/Rooms
RoomTypetype: array[string]Type of room. Can be go, peer_to_peer, group, or group_small.
gopeer_to_peergroupgroup_smallCodectype: array[string]Codecs used by participants in the room. Can be VP8, H264, or VP9.
VP8H264VP9CreatedAftertype: string<date-time>Only read rooms that started on or after this ISO 8601 timestamp.
CreatedBeforetype: string<date-time>Only read rooms that started before this ISO 8601 timestamp.
PageSizetype: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
The Room resource returns the Video Log Analyzer data for the provided room SID.
_10GET https://insights.twilio.com/v1/Video/Rooms/{Room_SID}
A Room Summary log is represented by the following properties:
room_typetype: enum<string>Type of room. Can be go, peer_to_peer, group, or group_small.
gopeer_to_peergroupgroup_smallroom_statustype: enum<string>Status of the room. Can be in_progress or completed.
in_progresscompletedstatus_callback_methodtype: enum<http-method>HTTP method provided for status callback URL.
GETPOSTcreated_methodtype: enum<string>How the room was created. Can be sdk, ad_hoc, or api.
sdkad_hocapiend_reasontype: enum<string>Reason the room ended. Can be room_ended_via_api or timeout.
room_ended_via_apitimeoutmax_participantstype: integerMax number of total participants allowed by the application settings.
unique_participantstype: integerNumber of participants. May include duplicate identities for participants who left and rejoined.
max_concurrent_participantstype: integerMaximum number of participants allowed in the room at the same time allowed by the application settings.
codecstype: array[string]Codecs used by participants in the room. Can be VP8, H264, or VP9.
VP8H264VP9media_regiontype: enum<string>Region of Twilio media servers for the room. See the list of possible media servers here.
us1us2au1br1ie1jp1sg1in1de1glltotal_participant_duration_sectype: integer<int64>Combined amount of participant time in the room.
total_recording_duration_sectype: integer<int64>Combined amount of recorded seconds for participants in the room.
processing_statetype: enum<string>Video Log Analyzer resource state. Will be either in-progress or complete. in-progress indicates that more details may be appended to the resource. complete indicates no further information will be added.
completein_progressedge_locationtype: enum<string>Edge location of Twilio media servers for the room. See the list of public edge locations for the possible values.
ashburndublinfrankfurtsingaporesydneysao_pauloroamingumatillatokyoThe Participants list returns the participant details for a provided room SID.
_10GET https://insights.twilio.com/v1/Video/Rooms/{Room_SID}/Participants
PageSizetype: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
The Participant resource returns the Video Log Analyzer details for a provided room participant SID.
_10GET https://insights.twilio.com/v1/Video/Rooms/{Room_SID}/Participants/{Partcipant_SID}
A participant summary is represented by the following properties:
participant_identitytype: stringThe application-defined string that uniquely identifies the participant within a Room.
statustype: enum<string>Status of the room. Can be in_progress or completed.
in_progresscompletedcodecstype: array[string]Codecs detected from the participant. Can be VP8, H264, or VP9.
VP8H264VP9media_regiontype: enum<string>Twilio media region the participant connected to. See the list of possible media servers here.
us1us2au1br1ie1jp1sg1in1de1gllpropertiestype: objectObject containing information about the participant's data from the room. See below for more information.
edge_locationtype: enum<string>Name of the edge location the participant connected to. See the list of public edge locations for the possible values.
ashburndublinfrankfurtsingaporesydneysao_pauloroamingumatillatokyopublisher_infotype: objectObject containing information about the SDK name and version. See below for more information.
The properties object contains the following keys:
| Name | Description |
|---|---|
| recordOnConnect | Boolean. Indicates if the participant was recorded as soon as they joined the room. |
| numAudioTracks | Number of audio tracks from the participant. |
| numVideoTracks | Number of video tracks from the participant. |
| numDataTracks | Number of data tracks from the participant. |
| isAdhoc | Boolean. Indicates if the participant joined the room ad-hoc. |
The publisher_info object contains the following keys:
| Name | Description |
|---|---|
| name | SDK type; e.g., twilio-video-js |
| sdk_version | SDK version |
Below are the possible options for a participant end_reason:
_47disconnected_via_api_47signaling_connection_error_47signaling_connection_disconnected_47signaling_connection_timed_out_47client_received_an_invalid_signaling_message_47client_sent_an_invalid_signaling_message_47room_name_is_invalid_47room_name_is_too_long_47room_name_contains_invalid_characters_47unable_to_create_room_47unable_to_connect_to_room_47room_contains_too_many_participants_47room_not_found_47max_participants_is_out_of_range_47room_type_is_not_valid_47timeout_is_out_of_range_47status_callback_method_is_invalid_47status_callback_is_invalid_47status_is_invalid_47room_creation_failed_47room_completed_error_47the_room_account_limit_was_exceeded_47invalid_recording_rule_47approaching_room_or_participant_concurrency_limits_47recording_operation_requested_is_not_supported_for_the_Room_type_47participant_identity_is_invalid_47participant_identity_is_too_long_47participant_identity_contains_invalid_characters_47participant_has_too_many_tracks_47participant_not_found_47participant_disconnected_because_of_duplicate_identity_47participant_account_limit_was_exceeded_47invalid_subscribe_rule_47track_is_invalid_47track_name_is_invalid_47track_name_is_too_long_47track_name_contains_invalid_characters_47track_name_is_duplicated_47client_is_unable_to_create_or_apply_a_local_media_description_47server_is_unable_to_create_or_apply_a_local_media_description_47client_is_unable_to_apply_a_remote_media_description_47server_is_unable_to_apply_a_remote_media_description_47no_supported_codec_47media_connection_failed_or_media_activity_ceased_47unable_to_acquire_configuration_47unable_to_acquire_TURN_credentials_47unknown