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

InfluxData Views API

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

InfluxData Views API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 1 path, and defines 56 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

Requests are made against a single base URL, /api/v2.

2 operations 1 paths 56 schemas 1 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.1
Base URL
https://us-east-1-1.aws.cloud2.influxdata.com/api/v2
Authentication
API Key, HTTP Basic
License
Resource Areas
1

Authentication & Security 2

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

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

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
/dashboards/{dashboardID}/cells/{cellID}/view
Retrieve the view for a cell
GetDashboardsIDCellsIDView 3 params → 200404default
PATCH
/dashboards/{dashboardID}/cells/{cellID}/view
Update the view for a cell
PatchDashboardsIDCellsIDView 3 params body → 200404default

Schemas 56

The contract defines 56 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.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-views-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Backup API
InfluxData Bucket Schemas API
InfluxData Buckets API
InfluxData Cells API
InfluxData Checks API
InfluxData Config API
InfluxData Dashboards API
InfluxData Data I/O endpoints API
InfluxData DBRPs API
InfluxData Debug API
InfluxData Delete API