Menu

Expand
Rate this page:

Video Log Analyzer API

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.

Base URL

Video Log Analyzer data is available under the following base URL. The REST API is served over HTTPS; unencrypted HTTP is not supported.

https://insights.twilio.com/v1/Video/Rooms

Authentication

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.

Get Rooms List

The Rooms list provides a queryable list of Programmable Video Rooms.

GET https://insights.twilio.com/v1/Video/Rooms
        
        
        
        
        Parameters in REST API format
        room_type
        Optional
        get ienum:room_type[] Not PII

        Type of room. Can be go, peer_to_peer, group, or group_small.

        codec
        Optional
        get ienum:codec[] Not PII

        Codecs used by participants in the room. Can be VP8, H264, or VP9.

        room_name
        Optional
        get string Not PII

        Room friendly name.

        created_after
        Optional
        get date_time<iso8601> Not PII

        Only read rooms that started on or after this ISO 8601 timestamp.

        created_before
        Optional
        get date_time<iso8601> Not PII

        Only read rooms that started before this ISO 8601 timestamp.

        Get Video Log Analyzer Data for a Room

        The Room resource returns the Video Log Analyzer data for the provided room SID.

        GET https://insights.twilio.com/v1/Video/Rooms/{Room_SID}
              
              
              
              
              Parameters in REST API format
              room_sid
              Path
              get sid_like<RM> Not PII

              The SID of the Room resource.

              Room Summary Resource Properties

              A Room Summary log is represented by the following properties:

              Resource Properties in REST API format
              account_sid
              sid<AC> Not PII

              Account SID associated with this room.

              room_sid
              sid<RM> Not PII

              Unique identifier for the room.

              room_name
              string Not PII

              Room friendly name.

              create_time
              date_time<iso8601> Not PII

              Creation time of the room.

              end_time
              date_time<iso8601> Not PII

              End time for the room.

              room_type
              enum:room_type Not PII

              Type of room. Can be go, peer_to_peer, group, or group_small.

              room_status
              enum:room_status Not PII

              Status of the room. Can be in_progress or completed.

              status_callback
              url Not PII

              Webhook provided for status callbacks.

              status_callback_method
              http_method Not PII

              HTTP method provided for status callback URL.

              created_method
              enum:created_method Not PII

              How the room was created. Can be sdk, ad_hoc, or api.

              end_reason
              enum:end_reason Not PII

              Reason the room ended. Can be room_ended_via_api or timeout.

              max_participants
              integer? Not PII

              Max number of total participants allowed by the application settings.

              unique_participants
              integer? Not PII

              Number of participants. May include duplicate identities for participants who left and rejoined.

              unique_participant_identities
              integer? Not PII

              Unique number of participant identities.

              concurrent_participants
              integer? Not PII

              Actual number of concurrent participants.

              max_concurrent_participants
              integer? Not PII

              Maximum number of participants allowed in the room at the same time allowed by the application settings.

              codecs
              enum:codec[] Not PII

              Codecs used by participants in the room. Can be VP8, H264, or VP9.

              media_region
              enum:twilio_realm Not PII

              Region of Twilio media servers for the room. See the list of possible media servers here.

              duration_sec
              long Not PII

              Total room duration from create time to end time.

              total_participant_duration_sec
              long Not PII

              Combined amount of participant time in the room.

              total_recording_duration_sec
              long Not PII

              Combined amount of recorded seconds for participants in the room.

              processing_state
              enum:processing_state Not PII

              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.

              recording_enabled
              boolean Not PII

              Boolean indicating if recording is enabled for the room.

              edge_location
              enum:edge_location Not PII

              Edge location of Twilio media servers for the room. See the list of public edge locations for the possible values.

              url
              url Not PII

              URL for the room resource.

              links
              uri_map Not PII

              Room subresources.

              Get Participants List

              The Participants list returns the participant details for a provided room SID.

              GET https://insights.twilio.com/v1/Video/Rooms/{Room_SID}/Participants
                    
                    
                    
                    
                    Parameters in REST API format
                    room_sid
                    Path
                    get sid_like<RM> Not PII

                    The SID of the Room resource.

                    Get Video Log Analyzer data for a Room Participant

                    The Participant resource returns the Video Log Analyzer details for a provided room participant SID.

                    GET https://insights.twilio.com/v1/Video/Rooms/{Room_SID}/Participants/{Partcipant_SID}
                          
                          
                          
                          
                          Parameters in REST API format
                          room_sid
                          Path
                          get sid_like<RM> Not PII

                          The SID of the Room resource.

                          participant_sid
                          Path
                          get sid_like<PA> Not PII

                          The SID of the Participant resource.

                          Participant Summary Resource Properties

                          A participant summary is represented by the following properties:

                          Resource Properties in REST API format
                          participant_sid
                          sid<PA> Not PII

                          Unique identifier for the participant.

                          participant_identity
                          string Not PII

                          The application-defined string that uniquely identifies the participant within a Room.

                          join_time
                          date_time<iso8601> Not PII

                          When the participant joined the room.

                          leave_time
                          date_time<iso8601> Not PII

                          When the participant left the room.

                          duration_sec
                          long Not PII

                          Amount of time in seconds the participant was in the room.

                          account_sid
                          sid<AC> Not PII

                          Account SID associated with the room.

                          room_sid
                          sid<RM> Not PII

                          Unique identifier for the room.

                          status
                          enum:room_status Not PII

                          Status of the room. Can be in_progress or completed.

                          codecs
                          enum:codec[] Not PII

                          Codecs detected from the participant. Can be VP8, H264, or VP9.

                          end_reason
                          string Not PII

                          Reason the participant left the room. See the list of possible values here.

                          error_code
                          integer? Not PII

                          Errors encountered by the participant.

                          error_code_url
                          string Not PII

                          Twilio error code dictionary link.

                          media_region
                          enum:twilio_realm Not PII

                          Twilio media region the participant connected to. See the list of possible media servers here.

                          properties
                          object Not PII

                          Object containing information about the participant's data from the room. See below for more information.

                          edge_location
                          enum:edge_location Not PII

                          Name of the edge location the participant connected to. See the list of public edge locations for the possible values.

                          publisher_info
                          object Not PII

                          Object containing information about the SDK name and version. See below for more information.

                          url
                          url Not PII

                          URL of the participant resource.

                          properties

                          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.

                          publisher_info

                          The publisher_info object contains the following keys:

                          Name Description
                          name SDK type; e.g., twilio-video-js
                          sdk_version SDK version

                          end_reason

                          Below are the possible options for a participant end_reason:

                          disconnected_via_api
                          signaling_connection_error
                          signaling_connection_disconnected
                          signaling_connection_timed_out
                          client_received_an_invalid_signaling_message
                          client_sent_an_invalid_signaling_message
                          room_name_is_invalid
                          room_name_is_too_long
                          room_name_contains_invalid_characters
                          unable_to_create_room
                          unable_to_connect_to_room
                          room_contains_too_many_participants
                          room_not_found
                          max_participants_is_out_of_range
                          room_type_is_not_valid
                          timeout_is_out_of_range
                          status_callback_method_is_invalid
                          status_callback_is_invalid
                          status_is_invalid
                          room_creation_failed
                          room_completed_error
                          the_room_account_limit_was_exceeded
                          invalid_recording_rule
                          approaching_room_or_participant_concurrency_limits
                          recording_operation_requested_is_not_supported_for_the_Room_type
                          participant_identity_is_invalid
                          participant_identity_is_too_long
                          participant_identity_contains_invalid_characters
                          participant_has_too_many_tracks
                          participant_not_found
                          participant_disconnected_because_of_duplicate_identity
                          participant_account_limit_was_exceeded
                          invalid_subscribe_rule
                          track_is_invalid
                          track_name_is_invalid
                          track_name_is_too_long
                          track_name_contains_invalid_characters
                          track_name_is_duplicated
                          client_is_unable_to_create_or_apply_a_local_media_description
                          server_is_unable_to_create_or_apply_a_local_media_description
                          client_is_unable_to_apply_a_remote_media_description
                          server_is_unable_to_apply_a_remote_media_description
                          no_supported_codec
                          media_connection_failed_or_media_activity_ceased
                          unable_to_acquire_configuration
                          unable_to_acquire_TURN_credentials
                          unknown
                          
                          Rate this page:

                          Need some help?

                          We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

                                
                                
                                

                                Thank you for your feedback!

                                We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

                                Sending your feedback...
                                🎉 Thank you for your feedback!
                                Something went wrong. Please try again.

                                Thanks for your feedback!

                                Refer us and get $10 in 3 simple steps!

                                Step 1

                                Get link

                                Get a free personal referral link here

                                Step 2

                                Give $10

                                Your user signs up and upgrade using link

                                Step 3

                                Get $10

                                1,250 free SMSes
                                OR 1,000 free voice mins
                                OR 12,000 chats
                                OR more