Shareable Links

    What you are going to learn:

  • What are shareable links
  • How to create and manage a shareable link
  • What recipients see when they open a link

A shareable link gives anyone read-only access to the performance data of a Network Monitoring Session. People who open the link do not need an Obkio account or to be logged into the App. This makes it easy to share what you see with your ISP or service provider's support team, an MSP's client or another IT team, so everyone looks at the same data while troubleshooting.

Each link has an expiry and can be revoked at any time.

Requirements
Requirements

  • Shareable links are disabled by default for all organizations. An Administrator must first enable them for the organization. Learn more on Enable Shareable Links.
  • Users with the Administrator or Standard User role can create and manage shareable links. Read-Only and Billing users can't. Learn more on User Roles.
  • For now, only Network Monitoring Session pages can be shared. More pages will be supported in the future.

The Share button is only displayed on session pages when shareable links are enabled for the organization. If you don't see it, ask an Administrator of your organization to enable shareable links.

Enable Shareable Links
Enable Shareable Links

Only an Administrator can enable shareable links for the organization:

  1. Go to the Organization settings (Menu -> Company Name) and click on Change Organization's Advanced Parameters.
  2. In the General tab, under Security, check Allow public share links.

Enable Shareable Links

The setting is saved automatically.

Important: Unchecking Allow public share links stops every existing link of the organization at once. Recipients then see the expired link page, and the Share button is no longer available.

Create a Shareable Link
Create a Shareable Link

  1. In the App, go to the Network Performance tab and open a Network Monitoring Session.
  2. Click Share at the top of the session page. The Share this session window opens.
  3. Enter a Link Name. By default, it is the name of the two agents of the session. The name is limited to 40 characters and can't be changed after the link is created.
  4. Select how long the link stays valid in Expires after: 1 day, 7 days (default), 30 days, 90 days, 1 year or Custom…. With Custom…, enter a number of days, weeks or months, between 1 day and 730 days (2 years).
  5. Click Create link.

The window then shows Link ready to share. Click Copy link to copy the link and send it to the people who need it, or Open in new tab to see the page as recipients will see it.

Create a Shareable Link

Note: Anyone who has the link can open it until it expires or is revoked. Share it only with the people who need it.

Manage a Shareable Link
Manage a Shareable Link

Once a session has a valid link, the button at the top of the session page reads Sharing instead of Share. Click Sharing to:

  • Copy or open the link: Click Copy link or Open in new tab.
  • Change the expiry: Click Change next to the expiry date, select a new duration and click Save. The new duration is counted from now, not from the creation of the link, so it can be used to extend or shorten a link.
  • Revoke the link: Click Revoke. A revoked link can't be restored. To share the session again, create a new link.

When a link is revoked, it stops working right away for anyone who opens it. A recipient who already has the page open may keep seeing the data for up to about 15 minutes, until the page is refreshed. Data that the recipient already viewed or saved cannot be taken back.

A session can only have one shareable link at a time. If a session is already shared, including by another user, you can revoke its link and create a new one.

Shared Sessions in the Session List
Shared Sessions in the Session List

In the session list, an icon is shown next to the sessions that have a valid link. Hover over the icon to see Shared through a public link.

What Recipients See
What Recipients See

When a recipient opens the link, a read-only page of the session is displayed. Recipients only have access to this shared session page and can't access anything else in the App. The page is not indexed by search engines.

  • At the top of the page: Powered by Obkio.
  • The link name, then the two agents of the session with the current session status (for example, It's been Ok for 3h 12m).
  • The name of the user who shared the link and its expiry date.
  • A date selector. The default time range is Last 3 hours, and recipients can change it to any period.
  • The session's status overview (for example, All Good).
  • The Severity Summary, only when the session has issues.
  • The Network Quality, Network Response Time and VoIP Quality graphs. Learn more on Network Monitoring Session Graphs.
  • The traceroutes of the session, in both directions.

The name of your organization is not displayed on the page.

When a Link Stops Working
When a Link Stops Working

When a link is expired or revoked, recipients see the message This share link has expired or been revoked. instead of the session data.

The same message is displayed when:

  • An Administrator unchecks Allow public share links for the organization.
  • The user who created the link is removed from the organization.
  • The session or one of its agents is deleted.
  • The session is disabled. Learn more on Disabled Monitoring Sessions.

To give access again, create a new link.



Learn more ...