Figures
curl --request POST \
--url https://api.ionworks.com/projects/{project_id}/dashboards/figures \
--header 'Content-Type: application/json' \
--data '
{
"plots": [
{
"plot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"params": {}
}
]
}
'import requests
url = "https://api.ionworks.com/projects/{project_id}/dashboards/figures"
payload = { "plots": [
{
"plot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"params": {}
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({plots: [{plot_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', params: {}}]})
};
fetch('https://api.ionworks.com/projects/{project_id}/dashboards/figures', 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/projects/{project_id}/dashboards/figures",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'plots' => [
[
'plot_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'params' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/projects/{project_id}/dashboards/figures"
payload := strings.NewReader("{\n \"plots\": [\n {\n \"plot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"params\": {}\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ionworks.com/projects/{project_id}/dashboards/figures")
.header("Content-Type", "application/json")
.body("{\n \"plots\": [\n {\n \"plot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"params\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/projects/{project_id}/dashboards/figures")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"plots\": [\n {\n \"plot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"params\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"figures": [
{
"ok": true,
"plot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"figure": {},
"error": "<string>",
"warnings": [
"<string>"
],
"provenance_summary": {},
"cached": false,
"cost": {
"sources": 0,
"rows": 0,
"points": 0,
"ms": 0
},
"summary": {
"traces": 123,
"points": 123,
"trace_names": [
"<string>"
],
"x_range": [
123
],
"y_range": [
123
]
},
"datasets_summary": {},
"controls": {}
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Figures
Render the requested plots. A plot that fails comes back with ok=false.
Figures
curl --request POST \
--url https://api.ionworks.com/projects/{project_id}/dashboards/figures \
--header 'Content-Type: application/json' \
--data '
{
"plots": [
{
"plot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"params": {}
}
]
}
'import requests
url = "https://api.ionworks.com/projects/{project_id}/dashboards/figures"
payload = { "plots": [
{
"plot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"params": {}
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({plots: [{plot_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', params: {}}]})
};
fetch('https://api.ionworks.com/projects/{project_id}/dashboards/figures', 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/projects/{project_id}/dashboards/figures",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'plots' => [
[
'plot_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'params' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/projects/{project_id}/dashboards/figures"
payload := strings.NewReader("{\n \"plots\": [\n {\n \"plot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"params\": {}\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ionworks.com/projects/{project_id}/dashboards/figures")
.header("Content-Type", "application/json")
.body("{\n \"plots\": [\n {\n \"plot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"params\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/projects/{project_id}/dashboards/figures")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"plots\": [\n {\n \"plot_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"params\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"figures": [
{
"ok": true,
"plot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"figure": {},
"error": "<string>",
"warnings": [
"<string>"
],
"provenance_summary": {},
"cached": false,
"cost": {
"sources": 0,
"rows": 0,
"points": 0,
"ms": 0
},
"summary": {
"traces": 123,
"points": 123,
"trace_names": [
"<string>"
],
"x_range": [
123
],
"y_range": [
123
]
},
"datasets_summary": {},
"controls": {}
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Was this page helpful?