Query

Retrieves data from buckets.

Use this endpoint to send a Flux query request and retrieve data from a bucket.

Rate limits (with InfluxDB Cloud)

read rate limits apply. For more information, see limits and adjustable quotas.

Related guides

• Query with the InfluxDB API
• Get started with Flux

Analyzes a Flux query for syntax errors and returns the list of errors.

In the following sample query, from() is missing the property key.

```json
{ "query": "from(: \"iot_center\")\
            |> range(start: -90d)\
            |> filter(fn: (r) => r._measurement == \"environment\")",
  "type": "flux"
}
```

If you pass this in a request to the /api/v2/analyze endpoint, InfluxDB returns an errors list that contains an error object for the missing key.

Limitations

• The endpoint doesn’t validate values in the query–for example:

• The following sample query has correct syntax, but contains an incorrect from() property key:

  { "query": "from(foo: \"iot_center\")\
              |> range(start: -90d)\
              |> filter(fn: (r) => r._measurement == \"environment\")",
    "type": "flux"
  }

  If you pass this in a request to the /api/v2/analyze endpoint, InfluxDB returns an empty errors list.

Analyzes a Flux query and returns a complete package source Abstract Syntax Tree (AST) for the query.

Use this endpoint for deep query analysis such as debugging unexpected query results.

A Flux query AST provides a semantic, tree-like representation with contextual information about the query. The AST illustrates how the query is distributed into different components for execution.

Limitations

• The endpoint doesn’t validate values in the query–for example:

  The following sample Flux query has correct syntax, but contains an incorrect from() property key:

  from(foo: "iot_center")
      |> range(start: -90d)
      |> filter(fn: (r) => r._measurement == "environment")

  The following sample JSON shows how to pass the query in the request body:

  from(foo: "iot_center")
  |> range(start: -90d)
  |> filter(fn: (r) => r._measurement == "environment")

  The following code sample shows how to pass the query as JSON in the request body:

  { "query": "from(foo: \"iot_center\")\
                  |> range(start: -90d)\
                  |> filter(fn: (r) => r._measurement == \"environment\")"
  }

  Passing this to /api/v2/query/ast will return a successful response with a generated AST.

Lists Flux query suggestions. Each suggestion contains a Flux function name and parameters.

Use this endpoint to retrieve a list of Flux query suggestions used in the InfluxDB Flux Query Builder.

Limitations

• When writing a query, avoid using _functionName() helper functions exposed by this endpoint. Helper function names have an underscore (_) prefix and aren’t meant to be used directly in queries–for example:

  • To sort on a column and keep the top n records, use the top(n, columns=["_value"], tables=<-) function instead of the _sortLimit helper function. top uses _sortLimit.

Related Guides

• List of all Flux functions

Retrieves a query suggestion that contains the name and parameters of the requested function.

Use this endpoint to pass a branching suggestion (a Flux function name) and retrieve the parameters of the requested function.

Limitations

• Use /api/v2/query/suggestions/{name} (without a trailing slash). /api/v2/query/suggestions/{name}/ (note the trailing slash) results in a HTTP 301 Moved Permanently status.

• The function name must exist and must be spelled correctly.

Related Guides

• List of all Flux functions