What is the difference between public share and embed?
rtcStats offers two ways to let others view a session - public sharing and embedding. Here's how they differ and when to use each.
rtcStats offers two ways to let others view a session analysis: public share and embed. They look similar on the surface but work very differently.
Public share
Public sharing enables users to share a specific file view with anyone they want outside the project's team members. This is useful when you want to share a session performance with an end user or a customer for example. We use it ourselves for our Showcase, if you want to see it in action.
Public share is available on all plans. Just click the Share button inside the rtcStats dashboard to generate a public link like:
https://www.rtcstats.com/share/xxxxx/
A few important notes:
- Publicly shared views are created manually from inside the dashboard
- They are open to the world - anyone with the link can view the session
Public sharing is great for one-off troubleshooting - send a link to a colleague, attach it to a support ticket, or post it in a Slack channel.
Embed
Embed enables you to take a specific file view and incorporate it inside your own web application. This is a powerful capability to cloud services that wish to systematically share at scale performance metrics with their clients or wish to have a single pane of glass view towards everything on a session - what rtcStats knows as well as their own enriched data and context for a holistic view.
Embedding is available on the Enterprise plan. It lets you take a session and display it inside your own dashboard or support tool via an iframe.
- Programmable via the API - an
embedUrlis exposed in the session data - No rtcStats branding - the embedded view is clean for your users
- Closed to the world - accessible only from rtcstats.com and the domains you configure
- iframe support - load the page inside an
<iframe>in your configured domains
Embedding is designed for two main scenarios:
- Internal dashboards - reduce the clicks your support or operations team needs to investigate a WebRTC issue by placing session analysis alongside your existing monitoring tools
- Customer-facing dashboards - let your own customers (e.g., contact center clients) review media quality on their own, within your product
Side by side
| Public share | Embed | |
|---|---|---|
| Plans | All | Enterprise |
| Created via | Dashboard (manual) | API (programmatic) |
| Branding | rtcStats branded | No branding |
| Access | Anyone with the link | Predefined domains only |
| iframe | No | Yes |
How to get the embed URL from the API
When you upload a file via POST /api/rtcstats/v1.0/upload on the Enterprise plan, the response returns rtcstatsId and embedUrl. You can also retrieve the embed URL later:
- Call
GET /api/rtcstats/v1.0/sessions - On the Enterprise plan, each session includes an
embedUrlfield - Load that URL as the
srcof an<iframe>in your dashboard
See also
- Embeddable viewer - full setup guide including the rtcstats-server flow
- What file formats can I upload?
Was this page helpful?