List Logs | SignalWire

import requests
url = "https://{your_space_name}.signalwire.com/api/video/logs"
headers = {"Authorization": "Basic <project_id>:<api_token>"}
response = requests.get(url, headers=headers)
print(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": [
    {
      "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
      "source": "realtime_api",
      "type": "video_conference_session",
      "url": "https://example.signalwire.com/api/video/room_sessions/a1b2c3d4-5e6f-7890-abcd-ef1234567890",
      "room_name": "my_room",
      "status": "completed",
      "locked": false,
      "started_at": "2022-01-01T10:00:00Z",
      "ended_at": "2022-01-01T11:00:00Z",
      "charge": 0.01,
      "created_at": "2022-01-01T10:00:00Z",
      "charge_details": [
        {
          "description": "Video conference session charge",
          "charge": 0.005
        }
      ]
    }
  ]
}

List the available logs.

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.

Authentication

AuthorizationBasic

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)

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) ```

Query parameters

include_deletedbooleanOptionalDefaults to false

Include logs for deleted activity.

created_beforestringOptional

Return logs for activity prior to this date. Accepts date (YYYY-MM-DD) or ISO 8601 datetime formats.

created_onstringOptional

Return logs for activity on this date. Accepts date (YYYY-MM-DD) or ISO 8601 datetime formats.

created_afterstringOptional

Return logs for activity after this date. Accepts date (YYYY-MM-DD) or ISO 8601 datetime formats.

page_numberintegerOptional>=0Defaults to 0

Page number to return.

page_sizeintegerOptional1-1000Defaults to 50

Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.

page_tokenstringOptional

Token for cursor-based pagination.

Response

The request has succeeded.

linksobject

Pagination links.

datalist of objects

List of logs.

Permissions

Authentication

Query parameters

Response

Errors