HomeGuidesAPI ReferenceChangelog
Log In
API Reference

List a pipeline's live plots, or fetch one

The pipeline's LIVE plots — what its deployments are currently drawing, one per (twin, plot step). Overwritten on every triggered run, so there is exactly one current figure per plot and no history to page through. Without twin/script/dataframe this LISTS them; with all three it returns one, as the stored figure or as its series. Driven by the pipeline definition at each deployment's release crossed with that deployment's twins, so a renamed or removed plot step disappears instead of showing as a months-old "current" plot. Experiment plots are elsewhere and unchanged: they are one blob per execution, addressed by uuid at GET /plots//.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The UUID or the key of the pipeline

Query Params
string

hardware id — filters the listing, and required with script/dataframe on a templated pipeline

string

a plot step's script; with dataframe, returns that one plot

string

that plot step's input dataframe

string

'figure' (default) returns the stored Plotly figure so it renders like an experiment plot; 'data' projects its traces to series

Responses

400

script without dataframe, or an unknown format

404

That plot step has never produced a plot

422

format=data and nothing in the figure projects to series

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json