@dynatrace-sdk/client-query 1.0.0

package/docs/DOCS.md

@@ -0,0 +1,2833 @@
+# Storage – Query Service
+
+SDK package version **1.0.0**
+
+```bash
+npm install @dynatrace-sdk/client-query
+```
+
+Exposes an API to fetch records stored in Grail
+
+## queryAssistanceClient
+
+```js
+import { queryAssistanceClient } from '@dynatrace-sdk/client-query';
+```
+
+
+### queryAutocomplete
+
+<div class="padding-bottom--md">
+<strong>queryAssistanceClient.queryAutocomplete(config): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="#autocompleteresponse">AutocompleteResponse</a>&gt;</strong>
+
+<div class="padding-left--md">
+
+Get a structured list of suggestions for the query at the given position.
+
+## Overview
+
+We provide a list of suggestions that may be used after the cursor position. The following queries will all provide the
+same results:
+
+* `query: "f"`
+* `query: "f", cursorPosition:1`
+* `query: "fetch ", cursorPosition:1`
+
+Available fields:
+
+| Field       | Description                                                                                                                                                                             |
+|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| suggestions | a list of suggestions. Each item is a separate possible suggestion, despite they might have the same outputs.                                                                           |
+| optional    | whether the suggestion is optional. If `true`, the query until the cursor position might work. If `false`, the query is definitely incomplete or invalid if cut at the cursor position. |
+
+Fields in the `suggestions`
+
+| Field                  | Description                                                                                                |
+|------------------------|------------------------------------------------------------------------------------------------------------|
+| suggestion             | a string representing the whole suggestion. This information could also be derived from the parts.         |
+| alreadyTypedCharacters | how many characters of this suggestion have already been typed (and will be overridden by the suggestion). |
+| parts                  | a list of semantically enriched information on what are the parts of a suggestion.                         |
+
+Fields in `parts`
+
+| Field      | Description                                               |
+|------------|-----------------------------------------------------------|
+| suggestion | a string representing the current part of the suggestion. |
+| type       | current types: SPACE, PIPE, COMMAND (may be extended)     |
+
+The `type` helps to treat specific parts of the suggestion different to others; either by a different visualization,
+a link to docs, etc.
+
+
+**Parameters**
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config</strong>: Object
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The authorization context. Typically start with 'Bearer '.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.body</strong>: <a href="#autocompleterequest">AutocompleteRequest</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+
+#### Returns
+
+<div class="padding-left--md">
+A list of structured autocomplete suggestions.
+
+</div>
+
+
+
+
+
+</div>
+
+
+
+</div>
+
+
+### queryParse
+
+<div class="padding-bottom--md">
+<strong>queryAssistanceClient.queryParse(config): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="#dqlnode">DQLNode</a>&gt;</strong>
+
+<div class="padding-left--md">
+
+Get a structured tree of the canonical form of the query.
+
+## Overview
+
+Returns the parsed query as a tree, containing the structure of the canonical query. Tree-nodes can contain references to
+the token position where they originate from. This may help to provide hover effects, show canonical forms, mark
+optional items, and more.
+
+## Details
+
+The query tree consists of nodes that contain different additional information (everything optional):
+
+### General Fields
+
+Field | Mandatory |  Description
+----------------------- | --- | ----------------------------------------------------------------------------------------
+tokenPosition           | no  | optional. If present, it represents the position within the query string where the node refers to.
+isOptional              | no  | whether this node could be left out and the result would still be the same query (semantically).
+
+#### tokenPosition
+
+contains `start` (inclusive) and `end` (inclusive), both contain `index` (0 based; fur substrings), `line`
+and `column` (both 1-based; for readability).
+
+* If `tokenPosition` is present, it always contains start and end with all fields
+* If `tokenPosition` is not present, there might still be nested nodes that do contain a position
+* If `start == end`, the position refers to a single character
+* If `start &gt; end`, we know for sure that something was inserted.
+
+We can always check whether the canonical representation of a node matches the text in the tokenPosition to see whether
+something was inserted, removed, or changed.
+
+#### isOptional
+
+only present if it is true.
+
+Optional nodes can e.g. be optional braces that make a query more readable, but are not necessary. This could be used to
+enter *ghost braces* and *implicit functions* in the user's input field; maybe with different formatting
+(using the tokenPosition of sibling nodes we can also check whether the user wrote these or not).
+
+### Advanced Token Types
+
+each node is of one of following types and may contain more fields:
+
+* Terminal Node
+* ContainerNode
+* Alternative Node
+
+#### Terminal Node
+
+can be identified by checking whether `canonicalString` is present
+
+Field | Mandatory |  Description
+------------------------ | --- | ---------------------------------------------------------------------------------------
+type                     | yes | the type of the terminal node - do not confuse with the type of container nodes
+canonicalString          | yes | the canonical string representation. Concatenating the canonicalString of all nested terminal nodes provides the canonical form of the query.
+isMandatoryOnUserOrder   | no  | may only be present if (`type="BRACE_OPEN"` or `type="BRACE_CLOSE"`) and `isOptional=true`. For usage see section [Special node type: PARAMETERS](#special-node-type-parameters)
+
+##### Current types of terminal nodes (list might grow):
+
+* SPACE
+* LINEBREAK
+* INDENT
+* PIPE
+* DOT
+* COLON
+* COMMA
+* BRACE_OPEN
+* BRACE_CLOSE
+* BRACKET_OPEN
+* BRACKET_CLOSE
+* PARENTHESIS_OPEN
+* PARENTHESIS_CLOSE
+* QUOTE
+* SLASH
+* BOOLEAN_TRUE
+* BOOLEAN_FALSE
+* NULL
+* COMMAND_NAME
+* PARAMETER_KEY
+* PARAMETER_VALUE_SCOPE
+* FUNCTION_NAME
+* OPERATOR
+* TRAVERSAL_OPERATOR
+* TRAVERSAL_RELATION_NAME
+* TRAVERSAL_HOP_COUNT
+* SIMPLE_IDENTIFIER
+* NUMBER
+* STRING
+* TIME_UNIT
+* TIMESTAMP_VALUE
+* METRIC_KEY
+* VARIABLE
+
+#### ContainerNode
+
+can be identified by checking whether `children` is present
+
+Field | Mandatory |  Description
+----------------------- | --- | ----------------------------------------------------------------------------------------
+type                    | yes | the type of the container node - do not confuse with the type of terminal nodes
+children                | yes | the children for the node. might be of any type
+
+##### Current types of container nodes (list might grow):
+
+* QUERY
+* EXECUTION_BLOCK
+* COMMAND
+* COMMAND_SEPARATOR
+* PARAMETER_WITH_KEY
+* GROUP
+* PARAMETERS - check examples further down
+* PARAMETER_NAMING
+* PARAMETER_SEPARATOR
+* FUNCTION
+* FUNCTION_PART - check examples further down
+* EXPRESSION
+* IDENTIFIER
+* SOURCE_ID
+* DURATION
+* TIMESTAMP
+* TIMEFRAME
+* TRAVERSAL_PATH
+* TRAVERSAL_STEP
+
+##### Special node type: PARAMETERS
+
+can contain children representing the parameters. Every second child is of type PARAMETER_SEPARATOR.
+
+You may reorder the children based on their tokenPosition to get the user order. However, in this case,
+you need to consider `isMandatoryOnUserOrder` to determine whether the grouping braces are mandatory or not.
+
+###### Example
+
+For the query `SORT a, {direction:"descending", b}`, the canonical form is:
+
+`SORT a, {b, direction:"descending"}`
+
+This is the order, in which the parameters are returned in the query tree.
+Parameters are {a} and {{b} and {direction:"descending"}}. In this case, the braces are optional.
+
+`SORT a, {b, direction:"descending"}` is equivalent to `SORT a, b, direction:"descending"`
+
+However, if you reorder the children by tokenPosition, the braces are not optional, because
+
+`SORT a, direction:"descending", b` is interpreted as `SORT {a, direction:"descending"}, b`
+
+So, if the children in PARAMETERS are re-ordered by tokenPosition, braces (or in general: TerminalNodes)
+are only optional if `isOptional && !isMandatoryOnUserOrder`.
+
+##### Special node type: FUNCTION_PART
+
+A container node of type `FUNCTION` may contain nodes of type `FUNCTION_PART`.
+
+If those `FUNCTION_PART`s are marked as optional, this means you have to either include *all* or *none* of these
+optional function parts.
+
+*Example*:
+
+`filter anyMatch(a.b == 1, input:a)`
+
+The optional function parts are `anyMatch(` and `, input:a)`. If you leave out both, the command will still work:
+`filter a.b == 1` and return the same result. Using one of these optional function parts and removing the other will lead
+to an invalid query.
+
+#### Alternative Node
+
+can be identified by checking whether `alternatives` is present
+
+Field | Mandatory |  Description
+----------------------- | --- | ----------------------------------------------------------------------------------------
+alternatives            | yes | Type: Map&lt;AlternativeType, DQLNode&gt;
+
+When displaying the query, pick one option. You may use the other options for hovering, replacing, and more.
+
+##### Current values of AlternativeType (list might grow):
+
+* CANONICAL: This node is the one we will use for our canonical form
+* USER: An alternative that is also valid, but not canonical; and this version was picked by the user.
+* INFO: only if the canonical version is not present
+
+*Examples*:
+
+* `CANONICAL` is not present, `USER` is present: user's nodes are optional, but not canonical (usually optional nodes
+  are still canonical)
+* `CANONICAL` is present, `USER` is not present: same as if the canonical node was optional. If this happens, it is
+  likely that there is also an `INFO` node
+* `CANONICAL` is present, `USER` is present: there are different alternatives
+* `INFO` is present: usually if `CANONICAL` is not present (e.g. the parameter key for `FILTER a == 1`), there is an info node
+  for `FILTER condition:a == 1`. This `condition:` was neither written by the user nor is it canonical; but it might be
+  used to help the user understand what this parameter means.
+
+
+**Parameters**
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config</strong>: Object
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The authorization context. Typically start with 'Bearer '.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.body</strong>: <a href="#parserequest">ParseRequest</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+
+#### Returns
+
+<div class="padding-left--md">
+A node containing more nodes,  a node offering different (semantically equivalent) versions of the query parts, or a terminal node that shows the canonical form.
+
+</div>
+
+
+
+
+
+</div>
+
+
+
+</div>
+
+
+### queryVerify
+
+<div class="padding-bottom--md">
+<strong>queryAssistanceClient.queryVerify(config): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="#verifyresponse">VerifyResponse</a>&gt;</strong>
+
+<div class="padding-left--md">
+
+Verifies a query without executing it.
+
+## Overview
+
+Verifies the supplied query string and other query parameters for lack of any errors, but without actually
+submitting the query for execution.
+
+
+**Parameters**
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config</strong>: Object
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The authorization context. Typically start with 'Bearer '.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.body</strong>: <a href="#verifyrequest">VerifyRequest</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+
+#### Returns
+
+<div class="padding-left--md">
+Supplied query and parameters were verified.
+
+</div>
+
+
+
+
+
+</div>
+
+
+
+</div>
+
+
+
+
+## queryExecutionClient
+
+```js
+import { queryExecutionClient } from '@dynatrace-sdk/client-query';
+```
+
+
+### queryCancel
+
+<div class="padding-bottom--md">
+<strong>queryExecutionClient.queryCancel(config): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;void | <a href="#querypollresponse">QueryPollResponse</a>&gt;</strong>
+
+<div class="padding-left--md">
+
+Cancels the query and returns the result if the query was already finished, otherwise discards it.
+
+### Overview:
+
+Cancels a running Grail query and returns a list of records if the query already finished.
+
+### The response format:
+
+If the query was already finished, a response body including the result will be returned. Otherwise the response will contain no body.
+
+The result has three main sections:
+* the 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
+* the 'types' section describes the corresponding data types that a record field has.
+* the 'metadata' section contains information about the query like 'analysisTimeframe', 'timezone' or 'locale'.
+
+Every record has an implicit 'index' according to the position in the 'records' JSON array.
+The types section has a list of 1..N possibhttps://dev.deus-dev.internal.dynatracelabs.com/query-frontend/docs/rest/swagger-ui/index.html?urls.primaryName=v0.5#/Query%20Execution/query%3Acancelle type 'buckets'. Each such bucket has an 'indexRange' which indicates which
+records will find their field types in which bucket. The index range has two values start & end and can be thought of as [startIndex, endIndex).
+
+A field part of a record with index 'i' will find its corresponding field type by first locating the bucket that satisfies:
+
+```text
+startIndex &lt;= i &lt;= endIndex
+```
+
+Once the bucket is found the 'mappings' object has an entry for all the fields that are part of that record with index 'i'.
+
+
+Since enforcement of a particular schema is absent at ingestion time, it is possible to have records that share the same
+field name but their values are of a different type. This phenomenon will hence forth be named as a **"collision"**.
+When a collision does occur, we will create a new type 'bucket' that will have a different index range where
+the new record field types will be placed.
+It is guaranteed that every field of every record will have a corresponding type.
+**Clients should always take the included types into account when consuming records!**
+
+
+As an example, the following response highlights a collision, where a field called "cancelled" was ingested both as a
+boolean but also wrongly as a string. The first record contains the field "cancelled" as a string, but the very next record has the
+field with the same name but of boolean type. The types section has two entries. One corresponds to first record that has
+the field cancelled of type string. The second entry in the types section corresponds to the subsequent records which have
+the boolean field type.
+
+```json
+{
+  "state":"SUCCEEDED",
+  "ttlSeconds":197,
+  "result": {
+    "records": [
+      {
+        "type": "user_event",
+        "order_id": "1ea34-2515-1515-fe1g",
+        "cancelled": "true"
+      },
+      {
+        "type": "user_event",
+        "order_id": "2ea34-2515-1515-fe1g",
+        "cancelled": false
+      },
+      {
+        "type": "user_event",
+        "order_id": "3ea34-2515-1515-fe1g",
+        "cancelled": true
+      },
+      {
+        "type": "user_event",
+        "order_id": "4ea34-2515-1515-fe1g",
+        "cancelled": false
+      }
+    ],
+    "types": [
+      {
+        "indexRange": [
+          0,
+          1
+        ],
+        "mappings": {
+          "type": {
+            "type": "string"
+          },
+          "order_id": {
+            "type": "string"
+          },
+          "cancelled": {
+            "type": "string"
+          }
+        }
+      },
+      {
+        "indexRange": [
+          1,
+          4
+        ],
+        "mappings": {
+          "type": {
+            "type": "string"
+          },
+          "order_id": {
+            "type": "string"
+          },
+          "cancelled": {
+            "type": "boolean"
+          }
+        }
+      }
+    ],
+    "metadata": {
+      "query": "fetch events | ...",
+      "dqlVersion": "V0_3",
+      "appliedTimeframe": {
+        "start": 1657624357056,
+        "end": 1657631557056
+      },
+      "timezone": "Z",
+      "locale": ""
+    }
+  }
+}
+```
+
+### Field data types
+
+The possible Grail types encountered in the "types" section is limited to a list of well-defined types:
+```
+  BOOLEAN
+  STRING
+  DOUBLE
+  LONG
+  TIMESTAMP
+  TIMEFRAME
+  DURATION
+  BINARY
+  IP_ADDRESS
+  GEO_POINT
+  ARRAY
+  RECORD
+```
+
+
+**Parameters**
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config</strong>: Object
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.requestToken</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The request-token of the query.
+
+</div>
+
+
+
+</div>
+
+
+
+#### Returns
+
+<div class="padding-left--md">
+The query already finished.
+
+</div>
+
+
+
+
+
+</div>
+
+
+
+</div>
+
+
+### queryExecute
+
+<div class="padding-bottom--md">
+<strong>queryExecutionClient.queryExecute(config): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="#querystartresponse">QueryStartResponse</a>&gt;</strong>
+
+<div class="padding-left--md">
+
+Starts a Grail query.
+
+### Overview:
+
+Executes a query and returns a list of records.
+
+For details about the query language see the [Dynatrace Query Language documentation](https://dt-url.net/bv03yk8).
+
+### The response format:
+
+The json response will contain the state of the started query and a request token to reference it in future polling requests:
+
+```json
+{
+  "state":"RUNNING",
+  "requestToken":"5tCm27WbTHmyi+749/wGsw==",
+  "ttlSeconds":197
+}
+```
+
+
+**Parameters**
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config</strong>: Object
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.authorization</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The authorization context. Typically start with 'Bearer '.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.body</strong>: <a href="#executerequest">ExecuteRequest</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.enrich</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+If set additional data will be available in the metadata section.
+
+</div>
+
+
+
+</div>
+
+
+
+#### Returns
+
+<div class="padding-left--md">
+The final status and results of the supplied query if it finished within a supplied request-timeout-milliseconds. | The status of the query to start.
+
+</div>
+
+
+
+
+
+</div>
+
+
+
+</div>
+
+
+### queryPoll
+
+<div class="padding-bottom--md">
+<strong>queryExecutionClient.queryPoll(config): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&lt;<a href="#querypollresponse">QueryPollResponse</a>&gt;</strong>
+
+<div class="padding-left--md">
+
+Retrieves query status and final result from Grail.
+
+### Overview:
+
+Polls the status of a Grail query. Returns the status of the query, including the result if the query finished.
+
+### The response format:
+The response consists of:
+* The state of the query.
+* ttlSeconds until the query will be wiped
+* If the query succeeded, also a result
+
+```json
+{
+  "state":"RUNNING",
+  "ttlSeconds":197
+}
+```
+
+The result has two main sections:
+* The 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
+* The 'types' section describes the corresponding data types that a record field has.
+
+Every record has an implicit 'index' according to the position in the 'records' JSON array.
+The types section has a list of 1..N possible type 'buckets'. Each such bucket has an 'indexRange' which indicates which
+records will find their field types in which bucket. The index range has two values start & end and can be thought of as [startIndex, endIndex).
+
+A field part of a record with index 'i' will find its corresponding field type by first locating the bucket that satisfies:
+
+```text
+startIndex &lt;= i &lt;= endIndex
+```
+
+Once the bucket is found the 'mappings' object has an entry for all the fields that are part of that record with index 'i'.
+
+
+Since enforcement of a particular schema is absent at ingestion time, it is possible to have records that share the same
+field name but their values are of a different type. This phenomenon will hence forth be named as a **"collision"**.
+When a collision does occur, we will create a new type 'bucket' that will have a different index range where
+the new record field types will be placed.
+It is guaranteed that every field of every record will have a corresponding type.
+**Clients should always take the included types into account when consuming records!**
+
+As an example, the following response highlights a collision, where a field called "cancelled" was ingested both as a
+boolean but also wrongly as a string. The first record contains the field "cancelled" as a string, but the very next record has the
+field with the same name but of boolean type. The types section has two entries. One corresponds to first record that has
+the field cancelled of type string. The second entry in the types section corresponds to the subsequent records which have
+the boolean field type.
+
+```json
+{
+  "state":"SUCCEEDED",
+  "result": {
+    "records": [
+      {
+        "type": "user_event",
+        "order_id": "1ea34-2515-1515-fe1g",
+        "cancelled": "true"
+      },
+      {
+        "type": "user_event",
+        "order_id": "2ea34-2515-1515-fe1g",
+        "cancelled": false
+      },
+      {
+        "type": "user_event",
+        "order_id": "3ea34-2515-1515-fe1g",
+        "cancelled": true
+      },
+      {
+        "type": "user_event",
+        "order_id": "4ea34-2515-1515-fe1g",
+        "cancelled": false
+      }
+    ],
+    "types": [
+      {
+        "indexRange": [
+          0,
+          1
+        ],
+        "mappings": {
+          "type": {
+            "type": "string"
+          },
+          "order_id": {
+            "type": "string"
+          },
+          "cancelled": {
+            "type": "string"
+          }
+        }
+      },
+      {
+        "indexRange": [
+          1,
+          4
+        ],
+        "mappings": {
+          "type": {
+            "type": "string"
+          },
+          "order_id": {
+            "type": "string"
+          },
+          "cancelled": {
+            "type": "boolean"
+          }
+        }
+      }
+    ],
+    "metadata": {
+      "query": "fetch events | ...",
+      "dqlVersion": "V0_3",
+      "appliedTimeframe": {
+        "start": 1657624357056,
+        "end": 1657631557056
+      },
+      "timezone": "Z",
+      "locale": ""
+    }
+  }
+}
+```
+
+The possible Grail types ened in the "types" section is limited to a list of well-defined types:
+```
+  BOOLEAN
+  STRING
+  DOUBLE
+  LONG
+  TIMESTAMP
+  TIMEFRAME
+  DURATION
+  BINARY
+  IP_ADDRESS
+  GEO_POINT
+  ARRAY
+  RECORD
+```
+
+
+**Parameters**
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config</strong>: Object
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.enrich</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+If set additional data will be available in the metadata section.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.requestTimeoutMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+The request timeout in milliseconds. The response will be delayed for up to the specified time in milliseconds to wait for the result of the query.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>config.requestToken</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The request-token of the query.
+
+</div>
+
+
+
+</div>
+
+
+
+#### Returns
+
+<div class="padding-left--md">
+The current status and results of the supplied query.
+
+</div>
+
+
+
+
+
+</div>
+
+
+
+</div>
+
+
+
+
+## Types
+
+### AutocompleteRequest
+<div class="padding-left--md">
+
+
+
+
+
+<div class="padding-left--md padding-bottom--md">
+<strong>cursorPosition</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The full query string.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00'
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### AutocompleteResponse
+<div class="padding-left--md">
+
+
+
+The response of the autocomplete call.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>optional</strong>: boolean
+<div class="padding-left--md">
+
+True if the suggestions are optional.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>suggestedTtlSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+Suggested duration in seconds, for how long the response may be cached and reused by the client. It is derived from the volatility of the suggestions on the server (if the suggestions are static, how long the server will cache the volatile suggestions, ...). If not provided, then the result may be cached for long time. Value below 1 means that the result should not be cached.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>suggestions</strong>: Array&lt;<a href="#autocompletesuggestion">AutocompleteSuggestion</a>&gt;
+<div class="padding-left--md">
+
+The list of suggestions.
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### AutocompleteSuggestion
+<div class="padding-left--md">
+
+
+
+Single suggestion for completion of the query.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>alreadyTypedCharacters</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+Number of characters that the user user already typed for this suggestion.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>parts</strong>: Array&lt;<a href="#autocompletesuggestionpart">AutocompleteSuggestionPart</a>&gt;
+<div class="padding-left--md">
+
+List of suggestion parts.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>suggestion</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The suggested continuation of the query.
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### AutocompleteSuggestionPart
+<div class="padding-left--md">
+
+
+
+Part of the suggestion.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>info</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The type of the suggestion.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>suggestion</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The suggested continuation of the query.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>synopsis</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The synopsis of the suggestion.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>type</strong>: <a href="#tokentype">TokenType</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### DQLAlternativeNode
+<div class="padding-left--md">
+
+
+
+The DQL node that has alternatives.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>alternatives</strong>: object
+<div class="padding-left--md">
+
+The different alternatives.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>isOptional</strong>: boolean
+<div class="padding-left--md">
+
+True if the node is optional.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### DQLContainerNode
+<div class="padding-left--md">
+
+
+
+The DQL node that contains other nodes.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>children</strong>: Array&lt;<a href="#dqlnode">DQLNode</a>&gt;
+<div class="padding-left--md">
+
+The list of children nodes.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>isOptional</strong>: boolean
+<div class="padding-left--md">
+
+True if the node is optional.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>type</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The type of the node.
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### DQLNode
+<div class="padding-left--md">
+
+
+
+General Node in the DQL query.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>isOptional</strong>: boolean
+<div class="padding-left--md">
+
+True if the node is optional.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### DQLTerminalNode
+<div class="padding-left--md">
+
+
+
+Node that represents single token.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>canonicalString</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+Canonical form.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>isMandatoryOnUserOrder</strong>: boolean
+<div class="padding-left--md">
+
+For optional items only: whether this node becomes mandatory when user order is used. True only for some optional 'ghost braces'
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>isOptional</strong>: boolean
+<div class="padding-left--md">
+
+True if the node is optional.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>nodeType</strong>: <a href="#dqlnodenodetype">DQLNodeNodeType</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>tokenPosition</strong>: <a href="#tokenposition">TokenPosition</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>type</strong>: <a href="#tokentype">TokenType</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### ErrorEnvelope
+<div class="padding-left--md">
+
+
+
+An 'envelope' error object that has the mandatory error object.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>error</strong>: <a href="#errorresponse">ErrorResponse</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### ErrorResponse
+<div class="padding-left--md">
+
+
+
+The response for error state
+
+<div class="padding-left--md padding-bottom--md">
+<strong>code</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+Error code, which normally matches the HTTP error code.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>details</strong>: <a href="#errorresponsedetails">ErrorResponseDetails</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>message</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+A short, clear error message without details
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### ErrorResponseDetails
+<div class="padding-left--md">
+
+
+
+Detailed information about the error.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>arguments</strong>: Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt;
+<div class="padding-left--md">
+
+The arguments for the message format.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>errorMessage</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+Complete error message.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>errorMessageFormat</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The message format of the error message, string.format based.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>errorMessageFormatSpecifierTypes</strong>: Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt;
+<div class="padding-left--md">
+
+The corresponding DQL format specifier types for each format specifier used in the error message format.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>errorType</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The error type, e.g. COMMAND_NAME_MISSING
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>exceptionType</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The exception type.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>queryString</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+Submitted query string.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>syntaxErrorPosition</strong>: <a href="#tokenposition">TokenPosition</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### ExecuteRequest
+<div class="padding-left--md">
+
+
+
+
+
+<div class="padding-left--md padding-bottom--md">
+<strong>defaultSamplingRatio</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+In case not specified in the DQL string, the sampling ratio defined here is applied. Note that this is only applicable to log queries.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>defaultScanLimitGbytes</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+Limit in gigabytes for the amount data that will be scanned during read.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>defaultTimeframeEnd</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The query timeframe 'end' timestamp in ISO-8601 or RFC399 format. If the timeframe 'start' parameter is missing, the whole timeframe is ignored. &lt;em&gt;Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.&lt;/em&gt;
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>defaultTimeframeStart</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The query timeframe 'start' timestamp in ISO-8601 or RFC399 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. &lt;em&gt;Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.&lt;/em&gt;
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>enablePreview</strong>: boolean
+<div class="padding-left--md">
+
+Request preview results. If a preview is available within the request-timeout-milliseconds, then it will be returned as part of the response.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>fetchTimeoutSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+The query will stop after reaching the fetch-timeout.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>maxResultRecords</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+The maximum number of result records that this query will return.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The full query string.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>requestTimeoutMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+The time a client is willing to wait for the query result. In case the query finishes within the specified timeout, the query result is returned. Otherwise, the requestToken is returned, allowing polling for the result.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00'
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### FieldType
+<div class="padding-left--md">
+
+
+
+The possible type of a field in DQL.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>type</strong>: <a href="#fieldtypetype">FieldTypeType</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>types</strong>: Array&lt;<a href="#rangedfieldtypes">RangedFieldTypes</a>&gt;
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### GeoPoint
+<div class="padding-left--md">
+
+
+
+DQL data type representing a geolocation point.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>latitude</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+The coordinate that specifies the north–south position of a point on the surface of the earth.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>longitude</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+The coordinate that specifies the  east–west position of a point on the surface of the earth.
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### GrailMetadata
+<div class="padding-left--md">
+
+
+
+Collects various bits of metadata information.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>analysisTimeframe</strong>: <a href="#timeframe">Timeframe</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>canonicalQuery</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The canonical form of the query. It has normalized spaces and canonical constructs.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>dqlVersion</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The version of DQL that was used to process the query request.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>executionTimeMilliseconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+The time it took to execute the query.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+Effective locale for the query.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>notifications</strong>: Array&lt;<a href="#metadatanotification">MetadataNotification</a>&gt;
+<div class="padding-left--md">
+
+Collected messages during the execution of the query.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The submitted query.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>queryId</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The id of the query
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>scannedBytes</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+Number of scanned bytes during the query execution.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>scannedRecords</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+Number of scanned records during the query execution.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+Effective timezone for the query.
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### Metadata
+<div class="padding-left--md">
+
+
+
+Collects various bits of metadata information.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>grail</strong>: <a href="#grailmetadata">GrailMetadata</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>metrics</strong>: Array&lt;<a href="#metricmetadata">MetricMetadata</a>&gt;
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### MetadataNotification
+<div class="padding-left--md">
+
+
+
+The message that provides additional information about the execution of the query.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>arguments</strong>: Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt;
+<div class="padding-left--md">
+
+The arguments for the message format.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>message</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The complete message of the notification.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>messageFormat</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The message format of the notification, string.format based
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>messageFormatSpecifierTypes</strong>: Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt;
+<div class="padding-left--md">
+
+The corresponding DQL format specifier types for each format specifier used in the error message format.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>notificationType</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The notification type, e.g. LIMIT_ADDED.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>severity</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The severity of the notification, currently: INFO, WARN, ERROR.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>syntaxPosition</strong>: <a href="#tokenposition">TokenPosition</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### MetricMetadata
+<div class="padding-left--md">
+
+
+
+An object that defines additional metric metadata.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>description</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The description of the metadata.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>displayName</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The display name of the metadata.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>metric.key</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The metric key.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>unit</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The unit used.
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### ParseRequest
+<div class="padding-left--md">
+
+
+
+
+
+<div class="padding-left--md padding-bottom--md">
+<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The full query string.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00'
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### PositionInfo
+<div class="padding-left--md">
+
+
+
+The exact position in the query string.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>column</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+Query position column zero based index.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>index</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+Query position index.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>line</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+Query position line zero based index.
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### QueryPollResponse
+<div class="padding-left--md">
+
+
+
+The response of GET query:execute call.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>progress</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+The progress of the query from 0 to 100.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>result</strong>: <a href="#queryresult">QueryResult</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>state</strong>: <a href="#querystate">QueryState</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>ttlSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+Time to live in seconds.
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### QueryResult
+<div class="padding-left--md">
+
+
+
+The result of the DQL query.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>metadata</strong>: <a href="#metadata">Metadata</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>records</strong>: Array&lt;null | <a href="#resultrecord">ResultRecord</a>&gt;
+<div class="padding-left--md">
+
+List of records containing the result fields data.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>types</strong>: Array&lt;<a href="#rangedfieldtypes">RangedFieldTypes</a>&gt;
+<div class="padding-left--md">
+
+The data types for the result records.
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### QueryStartResponse
+<div class="padding-left--md">
+
+
+
+The response when starting a query.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>progress</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+The progress of the query from 0 to 100.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>requestToken</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The token returned by the POST query:execute call.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>result</strong>: <a href="#queryresult">QueryResult</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>state</strong>: <a href="#querystate">QueryState</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>ttlSeconds</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
+<div class="padding-left--md">
+
+Time to live in seconds.
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### RangedFieldTypes
+<div class="padding-left--md">
+
+
+
+The field type in range.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>indexRange</strong>: Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>&gt;
+<div class="padding-left--md">
+
+The range of elements at use this type in arrays (null for records).
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>mappings</strong>: <a href="#rangedfieldtypesmappings">RangedFieldTypesMappings</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### RangedFieldTypesMappings
+<div class="padding-left--md">
+
+
+
+The mapping between the field name and data type.
+
+
+
+</div>
+
+
+
+### ResultRecord
+<div class="padding-left--md">
+
+
+
+Single record that contains the result fields.
+
+
+
+</div>
+
+
+
+### Timeframe
+<div class="padding-left--md">
+
+
+
+DQL data type timeframe.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>end</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a>
+<div class="padding-left--md">
+
+The end time of the timeframe.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>start</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a>
+<div class="padding-left--md">
+
+The start time of the timeframe.
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### TokenPosition
+<div class="padding-left--md">
+
+
+
+The position of a token in a query string used for errors and notification to map the message to a specific part of the query.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>end</strong>: <a href="#positioninfo">PositionInfo</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>start</strong>: <a href="#positioninfo">PositionInfo</a>
+<div class="padding-left--md">
+
+
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### VerifyRequest
+<div class="padding-left--md">
+
+
+
+
+
+<div class="padding-left--md padding-bottom--md">
+<strong>locale</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The full query string.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>timezone</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00'
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+### VerifyResponse
+<div class="padding-left--md">
+
+
+
+Verify response.
+
+<div class="padding-left--md padding-bottom--md">
+<strong>notifications</strong>: Array&lt;<a href="#metadatanotification">MetadataNotification</a>&gt;
+<div class="padding-left--md">
+
+The notifications related to the supplied DQL query string.
+
+</div>
+
+
+
+</div>
+
+<div class="padding-left--md padding-bottom--md">
+<strong>valid</strong>: boolean
+<div class="padding-left--md">
+
+True if the supplied DQL query string is valid.
+
+</div>
+
+
+
+</div>
+
+
+</div>
+
+
+
+
+## Enums
+
+
+### DQLNodeNodeType
+
+<div class="padding-left--md">
+
+The type of the node.
+
+#### Enum keys
+
+<div class="padding-left--md">
+
+`Alternative` | `Container` | `Terminal`
+
+</div>
+
+
+</div>
+
+
+
+
+### FieldTypeType
+
+<div class="padding-left--md">
+
+
+
+#### Enum keys
+
+<div class="padding-left--md">
+
+`Array` | `Binary` | `Boolean` | `Double` | `Duration` | `GeoPoint` | `IpAddress` | `Long` | `Record` | `String` | `Timeframe` | `Timestamp` | `Undefined`
+
+</div>
+
+
+</div>
+
+
+
+
+### QueryState
+
+<div class="padding-left--md">
+
+Possible state of the query.
+
+#### Enum keys
+
+<div class="padding-left--md">
+
+`Cancelled` | `Failed` | `NotStarted` | `ResultGone` | `Running` | `Succeeded`
+
+</div>
+
+
+</div>
+
+
+
+
+### TokenType
+
+<div class="padding-left--md">
+
+The type of the autocomplete token.
+
+#### Enum keys
+
+<div class="padding-left--md">
+
+`Assignment` | `BooleanFalse` | `BooleanTrue` | `BraceClose` | `BraceOpen` | `BracketClose` | `BracketOpen` | `Colon` | `Comma` | `CommandName` | `Dot` | `EndComment` | `FunctionName` | `Indent` | `Linebreak` | `MetricKey` | `Null` | `Number` | `Operator` | `ParameterKey` | `ParameterValueScope` | `ParenthesisClose` | `ParenthesisOpen` | `Pipe` | `Quote` | `SimpleIdentifier` | `SingleQuote` | `Slash` | `Space` | `String` | `TimeUnit` | `TimeseriesAggregation` | `TimestampValue` | `TraversalHopCount` | `TraversalOperator` | `TraversalRelationName` | `Variable`
+
+</div>
+
+
+</div>
+
+
+
+