Get Pipeline Element Plot Data Batch

curl --request GET \
  --url https://api.ionworks.com/pipelines/elements/{element_id}/plot_data_batch

const options = {method: 'GET'};

fetch('https://api.ionworks.com/pipelines/elements/{element_id}/plot_data_batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ionworks.com/pipelines/elements/{element_id}/plot_data_batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ionworks.com/pipelines/elements/{element_id}/plot_data_batch"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ionworks.com/pipelines/elements/{element_id}/plot_data_batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "max_points": 123,
  "plots": [
    {
      "traces": [
        {
          "name": "<string>",
          "x": [
            123
          ],
          "y": [
            123
          ]
        }
      ],
      "layout": {},
      "objective_name": "<string>",
      "plot_index": 123,
      "complete": true,
      "window_rows": 123,
      "type": "<string>",
      "x_full_min": 123,
      "x_full_max": 123
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Pipeline

Get Pipeline Element Plot Data Batch

Return every validation plot of an element at full extent, in one response.

What the first paint of a validation section needs: one request for all objectives rather than two per objective. Each plot is decimated to at most max_points per trace, lowered evenly across the batch where the whole body would otherwise exceed the batch payload cap; the served budget is returned as max_points and each plot reports whether it is complete at that budget. Zoom into one plot through GET /pipelines/elements/{element_id}/plot_data.

curl --request GET \
  --url https://api.ionworks.com/pipelines/elements/{element_id}/plot_data_batch

const options = {method: 'GET'};

fetch('https://api.ionworks.com/pipelines/elements/{element_id}/plot_data_batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ionworks.com/pipelines/elements/{element_id}/plot_data_batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ionworks.com/pipelines/elements/{element_id}/plot_data_batch"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ionworks.com/pipelines/elements/{element_id}/plot_data_batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "max_points": 123,
  "plots": [
    {
      "traces": [
        {
          "name": "<string>",
          "x": [
            123
          ],
          "y": [
            123
          ]
        }
      ],
      "layout": {},
      "objective_name": "<string>",
      "plot_index": 123,
      "complete": true,
      "window_rows": 123,
      "type": "<string>",
      "x_full_min": 123,
      "x_full_max": 123
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

element_id

string

required

Query Parameters

max_points

integer

default:2000

Maximum points per trace

Required range: 100 <= x <= 80000

Response

Successful Response

Response from GET /pipelines/elements/{element_id}/plot_data_batch.

Every plot of every objective in one body, so the first paint of a validation section is one request rather than two per objective.

max_points

integer

required

plots

ValidationPlotDataBatchEntry · object[]

required

Show child attributes

API Reference

Cell Specifications

Cell Instances

Cell Measurements

Programs

Sites

Cyclers

Channels

Thermal chambers

Simulations

parameterized_models

discovery

Pipeline

simple_pipeline

protocols

users

jobs

optimization

optimizations

Organizations

project-webhooks

studies

Lab

Planned Measurements

Health check

Get Pipeline Element Plot Data Batch

Path Parameters

Query Parameters

Response