Menu

Expand
Rate this page:

Video Log Analyzer API (beta)

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. To learn more about how Twilio handles authentication, please refer to our security documentation. In short, 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.

curl -G https://insights.twilio.com/v1/Video/Rooms/ -u  
       '[YOUR ACCOUNT SID]:[YOUR AUTH TOKEN]'

Subresources

The following resources are available in the Video Log Analyzer REST API.

Resource Description
Rooms List Queryable list of Video Rooms
Room Video Log Analyzer data for a provided Room
Participant List List of participants associated with a Room
Participant Room Participant data

Get Rooms List

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

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

        Request Parameters

        Parameter options
        RoomType group, group_small, go, peer-to-peer
        Codec VP8, H264, VP9
        RoomName string
        CreatedAfter ISO8601 Date/Time
        CreatedBefore ISO8601 Date/Time
        PageSize Default 50
        PageToken string

        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}
              
              
              
              

              Resource Properties

              A Room log is represented by the following properties:

              Property Description
              max_concurrent_participants Max number of participants in the room at the same time by the application settings
              max_participants Max number of total participants allowed by the application settings
              media_region Region of Twilio media servers for the room
              create_time Creation time of the room
              room_sid Unique identifier for the room
              unique_participants Number of participants, may include duplicate identities for participants who left/rejoined
              status_callback_method HTTP method provided for status callback URL
              processing_state 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.
              unique_participant_identities Unique number of participant identities
              total_recording_duration_sec Combined amount of recorded seconds for participants in the room
              edge_location Edge location of Twilio media servers for the room
              room_name Room friendly name
              room_status Status of the room
              end_reason Reason the room ended
              codecs Codecs used by participants in the room
              url URL for the room resource
              total_participant_duration_sec Combined amount of participant time in the room
              account_sid Account SID associated with this room
              duration_sec Total room duration from create time to end time
              end_time End time for the room
              created_method How the room was created; sdk, ad_hoc, api.
              concurrent_participants Actual number of concurrent participants
              room_type Type of room, e.g. peer-to-peer, group
              recording_enabled Boolean
              status_callback Webhook provided for status callbacks
              links 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
                    
                    
                    
                    

                    Request Parameters

                    Parameter options
                    PageSize Default 50
                    PageToken string

                    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}
                          
                          
                          
                          

                          Resource Properties

                          A participant summary is represented by the following properties:

                          Property Description
                          status Status of the participant
                          properties.recordOnConnect Boolean. Indicates if the participant was recorded as soon as they joined the room
                          properties.numAudioTracks Number of audio tracks from the participant
                          properties.numVideoTracks Number of video tracks from the participant
                          properties.numDataTracks Number of data tracks from the participant
                          properties.isAdhoc Boolean. Indicates if the participant joined the room ad-hoc
                          publisher_info.name SDK type; e.g. twilio-video-js
                          publisher_info.sdk_version SDK version
                          edge_location Edge location name the participant connected to
                          codecs Codecs detected from the participant
                          account_sid Account SID associated with the room
                          url URL of the participant resource
                          duration_sec Amount of time in seconds the participant was in the room
                          end_reason Reason the participant left the room
                          leave_time When the participant left the room
                          room_sid Unique identifier for the room
                          participant_sid Unique identifier for the participant
                          media_region Twilio media region the participant connected to
                          error_code Errors encountered by the participant
                          join_time When the participant joined the room
                          error_code_url Twilio error code dictionary link
                          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