Managing Share Links via the API

Last updated: October 6, 2026

The Share Links API lets you create and manage read-only dashboard links from your own systems, for example to give every client a dashboard link automatically.

A Separate Key

The Share Links API uses its own API key. Your Metrics API key does not work here, and this key does not work for the Metrics API.

What You Can Do with It

  • Create share links for any brand in your workspace

  • Choose which tabs a link shows, and lock its filters so viewers see exactly the view you set up

  • Edit, extend or reactivate links

  • Delete links when access should end

Create your Share Links API Key

  1. Click your name at the bottom of the sidebar to open Settings.

  2. Open the Sharing tab.

  3. In the API Access card, generate your key.

  4. Copy the key and store it somewhere safe.

The card now shows API Key Active.

If you do not see the Sharing tab, ask your workspace owner for access.

Share Links Are Public

Anyone with a share link can open that dashboard. Show only the tabs your client needs, lock the filters, and delete links you no longer use. Keep your API key on a server, never in a website or app that others can open.

Full Documentation

Every endpoint, with examples, is in Integration Docs in the account menu at the bottom of the sidebar.


Related Articles

📄 Sharing your Dashboard

📄 Getting Started with the Metrics API