Sign in
Video Logs

List 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 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.

get/api/video/logs

Query parameters

include_deletedboolean

Include logs for deleted activity.

created_beforestring

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

created_onstring

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

created_afterstring

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

page_numberinteger

Page number to return.

page_sizeinteger

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

page_tokenstring

Token for cursor-based pagination.

Response

The request has succeeded.

Example response

{
  "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": [
    {
      "url": "https://example.signalwire.com/api/video/room_sessions/a1b2c3d4-5e6f-7890-abcd-ef1234567890",
      "room_name": "my_room",
      "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
        }
      ]
    }
  ]
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.