> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # List video logs GET https://%7BYour_Space_Name%7D.signalwire.com/api/video/logs Lists historical Video API activity in the project for usage review and troubleshooting. This collection does not manage live Rooms or Conferences; use [Get video log](/docs/apis/rest/video-logs/get-log) when you already have a log ID. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). Reference: https://signalwire.com/docs/apis/rest/video-logs/list-logs ## Authentication - `Authorization` header (basic auth, required) — SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ``` ## Request ### Query parameters - `include_deleted` (boolean, optional, default: false) — Include logs for deleted activity. - `created_before` (string, optional) — Return logs for activity prior to this date. Accepts date (YYYY-MM-DD) or ISO 8601 datetime formats. - `created_on` (string, optional) — Return logs for activity on this date. Accepts date (YYYY-MM-DD) or ISO 8601 datetime formats. - `created_after` (string, optional) — Return logs for activity after this date. Accepts date (YYYY-MM-DD) or ISO 8601 datetime formats. - `page_number` (integer, optional, default: 0) — Page number to return. - `page_size` (integer, optional, default: 50) — Specify the number of results to return on a single page. The default page size is `50` and the maximum is `1000`. - `page_token` (string, optional) — Token for cursor-based pagination. ## Response ### 200 The request has succeeded. - `links` (Video.PaginationLinks, required) — Pagination links. - `data` (list of Video.VideoLog, required) — List of logs. ## Errors ### 400 Bad Request Error The request is invalid. - `error` (enum, required) - Allowed values: `Bad Request` ### 401 Unauthorized Error Access is unauthorized. - `error` (enum, required) - Allowed values: `Unauthorized` ### 403 Forbidden Error Access is forbidden. - `error` (enum, required) - Allowed values: `Forbidden` ### 422 Unprocessable Entity Error The request contains invalid parameters. See errors for details. - `errors` (list of Types.StatusCodes.RestApiErrorItem, required) — List of validation errors. ### 500 Internal Server Error An internal server error occurred. - `error` (enum, required) - Allowed values: `Internal Server Error` ## Types ### Video.PaginationLinks Pagination links for list responses. - `self` (string, required) — Link to the current page. - `first` (string, required) — Link to the first page. - `next` (string, optional) — Link to the next page. - `prev` (string, optional) — Link to the previous page. ### Video.VideoLog A video log entry. Discarded logs return only `id`, `discarded_at`, and `created_at`. ### Types.StatusCodes.RestApiErrorItem Details about a specific error. - `type` (string, required) — The category of error. - `code` (string, required) — A specific error code. - `message` (string, required) — A description of what caused the error. - `url` (string, required) — A link to documentation about this error. - `attribute` (string, optional, nullable) — The request parameter that caused the error, if applicable. ### Video.Log Log object representing a video activity entry. - `id` (string, required) — A unique identifier for the log. - `source` (enum, required) — Source of this log entry. - Allowed values: `realtime_api` - `type` (enum, required) — Type of this log entry. - Allowed values: `video_room_session`, `video_conference_session` - `url` (string, required) — URL for the resource associated with this log entry. - `room_name` (string, required, nullable) — A named unique identifier for the room. - `status` (enum, required, nullable) — Status of the log entry. - Allowed values: `in-progress`, `completed` - `locked` (boolean, required) — Whether the room session is locked. - `started_at` (datetime, required, nullable) — Start time of the activity. - `ended_at` (datetime, required, nullable) — End time of the activity. - `charge` (double, required) — Charge amount for this activity, in dollars. - `created_at` (datetime, required) — Timestamp when the log was created. - `charge_details` (list of Video.ChargeDetail, required) — Details on charges associated with this log. ### Video.DiscardedLog A discarded/deleted video log entry. Returned when the log has been deleted. Only present when `include_deleted` is `true`. - `id` (string, required) — A unique identifier for the log. - `discarded_at` (datetime, required) — Date and time when the log was discarded. - `created_at` (datetime, required) — Date and time when the log was originally created. ### Video.ChargeDetail Charge detail item for logs. - `description` (string, required) — Description for this charge. - `charge` (double, required) — Charged amount, in dollars. ## Examples **Response** ```json { "links": { "self": "https://example.signalwire.com/api/video/rooms?page=2", "first": "https://example.signalwire.com/api/video/rooms?page=1", "next": "https://example.signalwire.com/api/video/rooms?page=3", "prev": "https://example.signalwire.com/api/video/rooms?page=1" }, "data": [ { "charge": 0.01, "charge_details": [ { "charge": 0.005, "description": "Video conference session charge" } ], "created_at": "2022-01-01T10:00:00Z", "ended_at": "2022-01-01T11:00:00Z", "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92", "locked": false, "room_name": "my_room", "source": "realtime_api", "started_at": "2022-01-01T10:00:00Z", "status": "completed", "type": "video_conference_session", "url": "https://example.signalwire.com/api/video/room_sessions/a1b2c3d4-5e6f-7890-abcd-ef1234567890" } ] } ``` **SDK Code** ```python import requests url = "https://{your_space_name}.signalwire.com/api/video/logs" response = requests.get(url, auth=("", "")) print(response.json()) ``` ```javascript const url = 'https://{your_space_name}.signalwire.com/api/video/logs'; const credentials = btoa(":"); const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://{your_space_name}.signalwire.com/api/video/logs" req, _ := http.NewRequest("GET", url, nil) req.SetBasicAuth("", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://{your_space_name}.signalwire.com/api/video/logs") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request.basic_auth("", "") response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://{your_space_name}.signalwire.com/api/video/logs") .basicAuth("", "") .asString(); ``` ```php request('GET', 'https://{your_space_name}.signalwire.com/api/video/logs', [ 'headers' => [ ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://{your_space_name}.signalwire.com/api/video/logs"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = ["Authorization": "Basic \(credentials)"] let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/video/logs")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```