Overview
The/explore route is a front end interface for constructing deep links into the Explore v1 engine (/explorer).
It interprets URL query parameters such as Run names, Asset names, Channels, and custom time ranges, and transforms them into a format understood by Explore v1.
This allows users to pre-load relevant context directly into the interface.
The
/explore route is not part of the public API. It exists to simplify user navigation into Explore v1 by encoding query state into the URL.
This enables pre-loading analysis views with specific filters, Runs, Channels, and time ranges.Parameters (/explore)
The /explore route accepts a set of query parameters that define which data should be preloaded when the Explore v1 interface opens. These parameters allow you to specify the Run, Assets, Channels, and optional time range to programmatically generate a plot render.
| Parameter | Type | Required | Description | Default value | Example |
|---|---|---|---|---|---|
run | String | No | The name of the Run to display. Used to scope the Explore view to a specific Run. | None | run-name |
assets | Array of strings | No | A comma-separated list of Asset names to display. Can be used with or without a Run. | None | asset-one%2Casset-two |
channels | Array of strings | No | A comma-separated list of Channel names to plot. | None | channel-a%2Cchannel-b%2Cchannel-c |
from | String (ISO 8601 format) | No | Start time of the data to display. | None | 2025-01-01T10%3A00%3A00Z |
to | String (ISO 8601 format) | No | End time of the data to display. | None | 2025-01-01T10%3A30%3A00Z |
Percent-encoded + defautl values for
from and to- Parameters must be percent-encoded for proper URL handling.
- If
fromandtoare not included in the route, the Explorer v1 page defaults to the start and stop times of the provided Run. - When both a
runand one or moreassetsare provided in the URL, theruntakes precedence, and the Asset associated with the run overrides any separately specifiedassets. This ensures the correct asset context is applied based on the selected Run.
Examples
The examples below usehttps://app.siftstack.com as the base URL. All paths begin with /explore and are appended to that base URL.
Build a link with run, assets, and channels
- The following
/exploreroute opens Explore v1 with- the
runset to run-name, - the
assetset to asset-name, and - the
channelsset to max_ground_temp and max_air_temp.
- the
- The comma (
,) in thechannelsparameter is encoded as%2C.
When both a
run and asset are provided, the run takes precedence. The asset tied to the run will override any separately specified asset value in the URL.Add a time range with from and to
- The following
/exploreroute opens Explore v1 with- the
runset to run-name, - the
assetset to asset-name, - the
channelsset to max_ground_temp and max_air_temp, and - a time range defined by
from(2021-09-25T10:14:11) and to(2021-10-14T13:29:37).
- the
- The time values (
fromandto) use the ISO 8601 format. - The comma (
,) inchannelsis encoded as%2C, and the colons (:) in thefromandtotimestamps are encoded as%3A.
If both a
run and an asset are included, the run determines the asset context. The asset associated with the run will override any provided asset parameter in the URL.Link with only run
- The following
/exploreroute opens Explore v1 with- the
runset to run-name. - No
assets,channels, or time range (fromandto) are explicitly defined.
- the
- No percent-encoding is required in this example.
Link with multiple assets with channels
- The following
/exploreroute opens Explore v1 with- the
assetsset to asset-one-name and asset-two-name, and - the
channelsset to max_air_temp and min_air_temp. - A time range is defined by
from(2021-09-25T10:14:11) and to(2021-10-14T13:29:37).
- the
- The time values (
fromandto) use the ISO 8601 format. - The commas (
,) in both theassetsandchannelsparameters are encoded as%2C, and the colons (:) in thefromandtotimestamp values are encoded as%3A.