InfluxData Query API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Query. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.
This API exposes
5 operations
across 5 paths,
and defines 52 schemas.
It is described by OpenAPI 3.0.0, at version 2.0.1.
Requests are made against a single base URL, /api/v2.
5 operations5 paths52 schemas2 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
InfluxData Query 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 5
Across 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Query 5
Retrieve data, analyze queries, and get query suggestions.
POST
/query/ast
Generate a query Abstract Syntax Tree (AST)
PostQueryAst2 paramsbody→ 200400default
GET
/query/suggestions
List Flux query suggestions
GetQuerySuggestions1 param→ 200301default
GET
/query/suggestions/{name}
Retrieve a query suggestion for a branching suggestion
GetQuerySuggestionsName2 params→ 200500
POST
/query/analyze
Analyze a Flux query
PostQueryAnalyze2 paramsbody→ 200400default
POST
/query
Query data
PostQuery5 paramsbody→ 200400401404429500default
Schemas 52
The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are Query (6 properties), File (5 properties), Dialect (5 properties), Error (4 properties). Each schema is shown below with its type and property counts.
MemberExpression
object
Represents accessing a property of an object
3 properties
MemberAssignment
object
Object property assignment
3 properties
TestStatement
object
Declares a Flux test case
2 properties
DictItem
object
A key-value pair in a dictionary.
3 properties
BinaryExpression
object
uses binary operators to act on two operands in an expression
4 properties
ObjectExpression
object
Allows the declaration of an anonymous object within a declaration
2 properties
NodeType
string
Type of AST node
PipeLiteral
object
Represents a specialized literal value, indicating the left hand value of a pipe expression
1 property
Expression
Block
object
A set of statements
2 properties
ConditionalExpression
object
Selects one of two expressions, Alternate or Consequent, depending on a third boolean expression, Test
4 properties
VariableAssignment
object
Represents the declaration of a variable
3 properties
AnalyzeQueryResponse
object
1 property
ImportDeclaration
object
Declares a package import
3 properties
ReturnStatement
object
Defines an expression to return
2 properties
UnaryExpression
object
Uses operators to act on a single operand in an expression
3 properties
Statement
Property
object
The value associated with a key
3 properties
CallExpression
object
Represents a function call
3 properties
ExpressionStatement
object
May consist of an expression that doesn't return a value and is executed solely for its side-effects
2 properties
Node
LanguageRequest
object
Flux query to be analyzed.
1 property1 required
BooleanLiteral
object
Represents boolean values
2 properties
DateTimeLiteral
object
Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/cloud/reference/glossary/rfc3339…
2 properties
FluxSuggestions
object
1 property
FloatLiteral
object
Represents floating point numbers according to the double representations defined by the IEEE-754-1985
2 properties
UnsignedIntegerLiteral
object
Represents integer numbers
2 properties
Dialect
object
Options for tabular data output. Default output is [annotated CSV](https://docs.influxdata.com/influxdb/cloud/reference/syntax/annotated-csv/csv-response-forma…
5 properties
BuiltinStatement
object
Declares a builtin identifier and its type
2 properties
Query
object
Query InfluxDB with the Flux language
6 properties1 required
Duration
object
A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed.
3 properties
PropertyKey
ArrayExpression
object
Used to create and directly specify the elements of an array object
2 properties
PackageClause
object
Defines a package identifier
2 properties
ParenExpression
object
Represents an expression wrapped in parenthesis
2 properties
File
object
Represents a source from a single file
5 properties
DurationLiteral
object
Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration
2 properties
FunctionExpression
object
Function expression
3 properties
OptionStatement
object
A single variable declaration
2 properties
ASTResponse
object
Contains the AST for the supplied Flux query
1 property
BadStatement
object
A placeholder for statements for which no correct statement nodes can be created
2 properties
IndexExpression
object
Represents indexing into an array
3 properties
Identifier
object
A valid Flux identifier
2 properties
IntegerLiteral
object
Represents integer numbers
2 properties
DictExpression
object
Used to create and directly specify the elements of a dictionary
2 properties
PipeExpression
object
Call expression with pipe argument
3 properties
RegexpLiteral
object
Expressions begin and end with / and are regular expressions with syntax accepted by RE2
2 properties
FluxSuggestion
object
2 properties
Package
object
Represents a complete package source tree.
4 properties
StringLiteral
object
Expressions begin and end with double quote marks
2 properties
LogicalExpression
object
Represents the rule conditions that collectively evaluate to either true or false
4 properties
Error
object
4 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
