Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxDB Views API

The Views API from InfluxDB — 1 operation(s) for views.

InfluxDB Views API is one of 40 APIs that InfluxDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Views. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, authentication docs, and a getting-started guide.

This API exposes 2 operations across 1 path, and defines 57 schemas. It is described by OpenAPI 3.0.0.

Requests are made against the base URL https://cloud2.influxdata.com/api/v2.

2 operations 1 paths 57 schemas 1 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://cloud2.influxdata.com/api/v2
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

InfluxDB Views API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuthentication). An API key is passed in the header as Authorization (TokenAuthentication). By default, every request must be authenticated.

  • BasicAuthentication — Basic authentication scheme Use the HTTP Basic authentication scheme for InfluxDB /api/v2 API operations that support it: Syntax Authorization: Basic BASE64ENC…
  • TokenAuthentication — Use the [Token authentication](section/Authentication/TokenAuthentication) scheme to authenticate to the InfluxDB API. In your API requests, send an Authorizat…

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Views 2
GET
/api/v2/dashboards/{dashboardID}/cells/{cellID}/view
Retrieve the view for a cell
GetDashboardsIDCellsIDView 3 params → 200404default
PATCH
/api/v2/dashboards/{dashboardID}/cells/{cellID}/view
Update the view for a cell
PatchDashboardsIDCellsIDView 3 params body → 200404default

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are ScatterViewProperties (32 properties), HeatmapViewProperties (31 properties), LinePlusSingleStatProperties (30 properties), MosaicViewProperties (29 properties). Each schema is shown below with its type and property counts.

AxisScale
string
Scale is the axis formatting scale. Supported: "log", "linear"
GaugeViewProperties
object
11 properties 11 required
XYGeom
string
ScatterViewProperties
object
32 properties 18 required
BuilderAggregateFunctionType
string
SimpleTableViewProperties
object
6 properties 6 required
Link
string
URI of resource.
HeatmapViewProperties
object
31 properties 17 required
ErrorCode
string
code is the machine-readable error code.
DashboardColor
object
Defines an encoding of data value into color space.
5 properties 5 required
DecimalPlaces
object
Indicates whether decimal places should be enforced, and how many digits it should show.
2 properties
CheckDiscriminator
DeadmanCheck
HistogramViewProperties
object
16 properties 12 required
ColorMapping
object
A color mapping is an object that maps time series data to a UI color scheme to allow the UI to render graphs consistent colors across reloads.
RenamableField
object
Describes a field that can be renamed and made visible or invisible.
3 properties
View
object
4 properties 2 required
LinePlusSingleStatProperties
object
30 properties 11 required
BuilderFunctionsType
object
1 property
DashboardQuery
object
4 properties
Label
object
4 properties
GeoHeatMapViewLayer
GreaterThreshold
CheckBase
object
15 properties 3 required
Labels
array
Error
object
4 properties 1 required
BuilderTagsType
object
3 properties
LesserThreshold
CheckStatusLevel
string
The state to record if check matches a criteria.
MarkdownViewProperties
object
3 properties 3 required
GeoViewLayer
object
BuilderConfig
object
4 properties
TableViewProperties
object
10 properties 10 required
GeoViewLayerProperties
object
1 property 1 required
GeoPointMapViewLayer
Axes
object
The viewport for a View's visualizations
2 properties 2 required
XYViewProperties
object
29 properties 9 required
Axis
object
Axis used in a visualization.
6 properties
CustomCheck
RangeThreshold
GeoViewProperties
object
15 properties 10 required
CheckViewProperties
object
11 properties 5 required
LatLonColumns
object
Object type to define lat/lon columns
2 properties 2 required
BandViewProperties
object
29 properties 8 required
QueryEditMode
string
TaskStatusType
string
inactive cancels scheduled runs and prevents manual runs of the task.
StaticLegend
object
StaticLegend represents the options specific to the static legend
7 properties
SingleStatViewProperties
object
12 properties 11 required
Threshold
MosaicViewProperties
object
29 properties 17 required
ThresholdCheck
ThresholdBase
object
2 properties
ViewProperties
LatLonColumn
object
Object type for key and column definitions
2 properties 2 required
Check
GeoTrackMapViewLayer
object
4 properties
GeoCircleViewLayer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdb-views-api-openapi.yml Raw ↑

Other APIs InfluxDB publishes across the network.

InfluxDB Authorizations (API tokens) API
InfluxDB Bucket Schemas API
InfluxDB Buckets API
InfluxDB Cells API
InfluxDB Checks API
InfluxDB Config API
InfluxDB Dashboards API
InfluxDB Data I/O endpoints API
InfluxDB DBRPs API
InfluxDB Delete API
InfluxDB Invokable Scripts API
InfluxDB Labels API