Using the Dashboard

The Xirsys dashboard is the control center for creating secure WebRTC connection points, copying the credentials your application needs, checking usage, and managing your account plan.

The dashboard is organized around four primary areas: Connect, Analytics, Account, and Plans. The API reference pages describe the underlying endpoints; this guide focuses on the dashboard workflows.

Quick Overview

• Connect is where you manage channels, copy dynamic API configuration, test connection responses, and work with static credentials when your plan supports them.
• Analytics shows usage by date range, channel, and report type in either a chart or grid view.
• Account holds profile, billing, and current-plan details.
• Plans lets you compare monthly or annual plans and upgrade when you need more bandwidth or premium features.

Connect

Use Connect to prepare a WebRTC application for STUN/TURN access. The important pieces are your API key, at least one channel, and either dynamic channel credentials or static credentials depending on how your application is built.

API Key

The API Key identifies your Xirsys account when your server calls the Xirsys API. Keep it private. For production applications, store it on a backend server and return only the ICE or signaling values your client needs.

Use copy when adding the key to a secure server environment. Use renew when you need to rotate the key. Renewing invalidates the previous key, so update any server configuration that uses it before rotating in production.

Manage Channels

A channel is a named connection point for one app, environment, tenant, or room grouping. Channels help keep usage, credentials, and troubleshooting organized.

Create a channel:

1. Open Connect.
2. In the Channel card, select the plus button.
3. Enter a channel name, then select Add.
4. Select the channel from the dropdown before copying credentials or running a test.

Channel names are case-sensitive complete identifiers. Use one name such as myChannel or myOtherChannel. Do not use forward slashes to build parent, application, or room segments.

Channel Credentials

The Channel Credentials card shows the current channel configuration. The Dynamic tab gives you the values your server needs to call the API for temporary ICE credentials. This is the recommended production workflow for most web applications.

The dynamic object includes:

• path: the Xirsys API endpoint.
• ident: the account identifier used for API authentication.
• secret: the API key. Keep it server-side.
• channel: the selected channel name.

Select copy to copy the object. Select Example to open a sample request that shows how to call the Xirsys TURN endpoint for that channel.

Static Credentials

The Static tab provides persistent ICE server credentials. Use static credentials only in trusted, controlled infrastructure where they can be protected and rotated. Credentials embedded in native or mobile software can be extracted, so most client applications should use dynamic credentials issued by a backend.

New Free accounts can create and use static credentials during their first 30 days. When the trial ends, the credentials remain listed but are archived and disabled: their usable secret is hidden and TURN rejects them. Refresh and copy are unavailable while archived, but you can still delete the record. Upgrading to a paid plan automatically reactivates the same static credentials. Dynamic credentials remain available on the Free plan.

Your Network

The Your Network card on the Connect page is authoritative for the Xirsys TURN regions enabled for your account. New Free accounts can use all available regions during their first 30 days; after the trial they use their assigned home region until upgrading. Paid plans include the production-region coverage advertised for the plan.

Select view to open the region-details dialog. Use the displayed list rather than a hard-coded region count in application logic or operating procedures.

Test Connection

Use Test Connection when you want to confirm that the selected channel can return TURN credentials. This is a quick dashboard check before wiring the values into application code.

1. Select the channel you want to test.
2. Select Test Connection.
3. In the test dialog, select start.
4. Review the example code and live TURN credential response.

Analytics

The Analytics page reports account activity over a selected date range. Use it to understand connection counts, STUN/TURN usage, bandwidth trends, and whether your current plan still fits your traffic. Reporting is rolled up hourly, so the newest activity may not appear immediately.

The main controls are:

• Report Dates: choose the start and end dates for the report.
• Report Target: view all channels or one selected channel.
• Report Type: choose STUN vs TURN, Bandwidth, or Session Duration.
• View: switch between the chart and grid. The button shows the active view, and its hover state previews the view that will open.

What Each Report Shows

• STUN vs TURN: daily connection counts for each connection type.
• Bandwidth: daily bytes received and sent during conversations.
• Session Duration: daily total conversation time, in seconds, separated by STUN and TURN.

Switch Between Chart and Grid

The chart displays one stacked bar per day, with one segment for each value in the selected report. Use the series buttons to show or hide either value. Select the View button to replace the chart with the grid; select it again to return to the chart.

The grid lists daily STUN and TURN counts, average duration, average bandwidth, total connections, and the channel for each row. When All Channels is selected, rows identify their individual channels. Report Totals remains below either view and moves down as the grid grows; switching views never removes the totals.

A loading or API failure is not treated as an empty report. If Analytics cannot load the report, it shows We couldn’t load analytics with a Retry button instead of either no-data message.

Use the plan summary at the top of the page to compare monthly bandwidth usage with your plan limit. Use the report filters and grid to identify channels or dates that need attention.

If your application assigns different versions, marketing campaigns, or audience groups to separate channels, select each channel as the Report Target and run the same report for the same date range. Comparing the results can help you evaluate a product change or marketing approach without mixing traffic from the groups.

Account

The Account page is divided into Account, Billing, and Plan tabs.

• Account: update user email, password, name, contact number, and company.
• Billing: manage payment information and view billing history.
• Plan: see the current plan, monthly cost, bandwidth, and plan actions.

Plans

Use Plans to compare available plans and switch between monthly and annual billing views. Each card shows the included bandwidth, overage pricing, supported regions, support level, and whether API plus static credentials are included.

Select Update Plan on the plan that fits your expected usage. If a premium dashboard feature prompts for an upgrade, the prompt routes to the same plan selection workflow.