Building and sharing links

Build and share deep links with your teammates to open Foxglove Studio (on web or desktop) with specific layouts and data sources.

To open Foxglove Studio using a specific layout or data source, construct a "deep link" URL using the format:

https://studio.foxglove.dev/?param1=value2&param2=value2

Supported query parameters are documented below, or you can copy any URL while you are using the app.

Web vs Desktop

By default, links will open in the browser. You can open the desktop app instead using the openIn parameter:

parametertyperequireddescription
openInstringweb (default)
desktop

Using openIn=desktop will attempt to open the Foxglove Studio desktop app (assuming it is installed), while providing a landing page giving users the option to download the app (if it is not installed), or to open the link in their browser instead. This is the preferred approach to open the desktop app, as it provides a graceful browser fallback option.

Alternatively, if you are sure the user has the desktop app installed, you can use the foxglove:// URL scheme to open it. This provides no browser fallback, and will fail silently if the desktop app is not installed.

prefixexample
https://studio.foxglove.dev/https://studio.foxglove.dev/?ds=sample-nuscenes&openIn=desktop
foxglove://openfoxglove://open?ds=sample-nuscenes

Layouts

To load a saved layout (personal or team):

parametertyperequireddescription
layoutIdstringFoxglove's ID for a remotely saved layout

To get a URL with the correct layoutId param, open the web app and click your desired layout in the Layouts sidebar.

Timestamp

parametertyperequireddescription
timetimestamp
(RFC3339)
Timestamp to seek to (for non-live data sources)

Data sources

To specify your data source, use the ds parameter as documented according to your desired data source below.

For example, a Rosbridge connection may look like the following:

https://studio.foxglove.dev/?ds=rosbridge-websocket&ds.url=ws%3A%2F%2Flocalhost%3A9090&layoutId=2644147b-f205-456c-ace9-69466aaac0b7

Foxglove WebSocket

parametertyperequireddescription
dsstringfoxglove-websocket
ds.urlstringWebSocket URL

Rosbridge

parametertyperequireddescription
dsstringrosbridge-websocket
ds.urlstringWebSocket URL

ROS 1 Native

(Supported on desktop only)

parametertyperequireddescription
dsstringros1-socket
ds.urlstringROS Master URI

ROS 2 Native

(Supported on desktop only)

parametertyperequireddescription
dsstringros2-socket
ds.urlstringROS Domain ID

Foxglove Data Platform

parametertyperequireddescription
dsstringfoxglove-data-platform
ds.deviceIdstringOne of ds.deviceId or ds.importId is requiredRobot ID
ds.starttimestamp
(RFC3339)
With ds.deviceIdStart of data playback range
ds.endtimestamp
(RFC3339)
With ds.deviceIdEnd of data playback range
ds.importIdstringOne of ds.deviceId or ds.importId is requiredImported data's ID in Foxglove Data Platform

Remote files

parametertyperequireddescription
dsstringremote-file
ds.urlstringURL to .bag or .mcap file