Skip to content
Tabular data visualization engine

Generate a self-contained Vizb HTML application from Datasets.

POST
/ui
curl --request POST \
  --url http://127.0.0.1:8080/ui \
  --header 'Content-Type: application/json' \
  --data '{ "datasets": { "name": "API latency", "axes": [ { "key": "name" }, { "key": "y", "type": "value" } ], "settings": [ { "type": "line", "smooth": true } ], "data": [ { "name": "west", "yAxis": "12" }, { "name": "east", "yAxis": "18" } ] }, "charts": { "types": [ "line" ] } }'

The request accepts one Dataset or a non-empty Dataset array. The generated response is returned directly and is never stored by the server. Remote data URLs are deliberately absent from the request model.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
datasets
required
One of:
object
id
string
tag
string
timestamp
string
name
required
string
theme
string
history
Array<object>
object
tag
required
string
timestamp
required
string
meta
object
cpu
object
name
string
cores
integer
os
string
arch
string
pkg
string
description
string
meta
object
cpu
object
name
string
cores
integer
os
string
arch
string
pkg
string
axes
required
Array<object>
object
key
required
string
Allowed values: name x y z
label
string
type
string
Allowed values: "" value
settings
required

Each chart type may appear at most once.

data
required
Array<object>
object
name
string
xAxis
string
yAxis
string
zAxis
string
metric
string
stats
Array<object>
object
type
string
value
number
symbol
string
preserveRows
boolean
charts
object
types
Array<string>
>= 1 items unique items
Allowed values: bar line scatter pie heatmap radar
configs
Array
One of: discriminator: type
object
type
required
Allowed value: bar
swap
string
sort
object
enabled
required
boolean
order
required
string
Allowed values: asc desc
scale
string
Allowed values: linear log
stack
boolean
showLabels
boolean
threeDRotate
boolean
threeD
boolean
threeDVisualMap
boolean
horizontal
boolean
stat
object
enabled
required
boolean
math
required
Array<string>
Allowed values: counts center spread extremes shape percentiles confidence correlations
statistics
object
enabled
boolean
math
Array<string>
unique items
Allowed values: counts center spread extremes shape percentiles confidence correlations
Examples
ExampledatasetUI

Render one Dataset with a filtered chart set.

{
  "datasets": {
    "name": "API latency",
    "axes": [
      {
        "key": "name"
      },
      {
        "key": "y",
        "type": "value"
      }
    ],
    "settings": [
      {
        "type": "line",
        "smooth": true
      }
    ],
    "data": [
      {
        "name": "west",
        "yAxis": "12"
      },
      {
        "name": "east",
        "yAxis": "18"
      }
    ]
  },
  "charts": {
    "types": [
      "line"
    ]
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Self-contained HTML was generated successfully.

Media typetext/html
string
Examples
ExampleselfContainedHTML
<!doctype html><html><head><title>Vizb</title></head><body>...</body></html>

400

Section titled “400”

The request body is not a single valid JSON value.

Media typeapplication/problem+json
object
type
required
string format: uri-reference
title
required
string
status
required
integer
detail
required
string
instance
string format: uri-reference
errors
required
Array<object>
>= 1 items
object
location
required
string
Allowed values: body header query
path
required

JSON Pointer or header/query name.

string
code
required
string
message
required
string
Example
{
  "errors": [
    {
      "location": "body"
    }
  ]
}

406

Section titled “406”

The request’s Accept header does not allow an operation’s selected response media type.

Media typeapplication/problem+json
object
type
required
string format: uri-reference
title
required
string
status
required
integer
detail
required
string
instance
string format: uri-reference
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

413

Section titled “413”

The request body exceeds the 10 MiB limit.

Media typeapplication/problem+json
object
type
required
string format: uri-reference
title
required
string
status
required
integer
detail
required
string
instance
string format: uri-reference
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

415

Section titled “415”

The request Content-Type is not application/json.

Media typeapplication/problem+json
object
type
required
string format: uri-reference
title
required
string
status
required
integer
detail
required
string
instance
string format: uri-reference
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

422

Section titled “422”

Valid JSON violates request schema or semantic constraints, or the supplied input cannot be processed.

Media typeapplication/problem+json
object
type
required
string format: uri-reference
title
required
string
status
required
integer
detail
required
string
instance
string format: uri-reference
Examples
{
  "type": "https://vizb.goptics.org/problems/validation",
  "title": "Unprocessable content",
  "status": 422,
  "detail": "Request validation failed.",
  "instance": "/merge",
  "errors": [
    {
      "location": "body",
      "path": "/tagAxis",
      "code": "invalid_enum",
      "message": "tagAxis must be one of name, x, y, or z."
    }
  ]
}

500

Section titled “500”

An unexpected server-side failure occurred.

Media typeapplication/problem+json
object
type
required
string format: uri-reference
title
required
string
status
required
integer
detail
required
string
instance
string format: uri-reference
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}