Sift | Docs

Redirecting to Explore

To achieve this, the user may make use of the following endpoint:

GET /explore

Redirects to the explorer page, pre-populated with the runs, assets, and channels that were specified by name in the URL query parameters.

Parameters:
- run (optional, string): The name of the run.
- assets (optional, array of strings): A list of asset names.
- channels (optional, array of strings): A list of channel names.
- from (optional, string): Start time of the data to display in ISO 8601 format.
- to (optional, string): End time of the data to display in ISO 8601 format.

Important note: Query parameters must be percent-encoded for proper URL handling.

The following is a list of examples for various use cases:

Run + Asset + Channels

Given the following resources:

  • A run named MarsRover0.134532351
  • An asset named MarsRover0
  • A channel named voltage.
  • A channel called control_unit.cpu,temperature.

To navigate to the explorer page, pre-populated with these resources, we would use the following percent-encoded URI:

/explore?run=MarsRover0.134532351&assets=MarsRover0&channels=temperature%2Ccontrol_unit.cpu.temperature

In this particular example. since from and to are not specified, the explorer page will default to using the start and top times of the provided run.

If we would like to specify a custom time range like the following:

  • from: 2024-02-01T23:00:05.425446Z
  • to: 2024-02-01T23:00:14.038709Z

We would add them as percent-encoded query parameters like so:

/explore?run=MarsRover0.134532351&assets=MarsRover0&channels=temperature%2Ccontrol_unit.cpu.temperature&from=2024-02-01T23%3A00%3A05.425446Z&to=2024-02-01T23%3A00%3A14.038709Z

A Single Run

Given the following resources, the same as before:

  • A run named MarsRover0.134532351
  • An asset named MarsRover0
  • A channel named voltage.
  • A channel called control_unit.cpu.temperature.

We may also specify the run on its own:

/explore?run=MarsRover0.134532351

Multiple Assets with Channels

Given the following resources:

  • An asset named MarsRover0

    • with channel temperature
  • An asset named MarsRover1

    • with channel motor.velocity

To view just the assets:

/explore?assets=MarsRover0%2CMarsRover1

And to view the assets with their channels:

/explore?assets=MarsRover0%2CMarsRover1&channels=temperature%2Cmotor.velocity

Redirecting Using a Run ID

If you have your run's ID on-hand, you can also visit the following URL to redirect to the explore page for your run:

/run/:runID

So if your runID is caf9d31b-26ff-4f14-9c9b-a4ff70d79411, the URL would look like the following:

/run/caf9d31b-26ff-4f14-9c9b-a4ff70d79411

On this page