The request token is returned when starting a long-running analyzer execution. It can be used to do follow-up operations like polling and cancelling.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[AnalyzerCancelResult](#analyzercancelresult)|200|The current analyzer execution status and an optional partial result.|\n|void|202|The cancel request was accepted and is being processed.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|AnalyzerErrorEnvelopeError|Invalid or malformed request. | Insufficient permissions. | No analyzer available with the requested name. | The analyzer result with the request token has already been consumed or its time-to-live (TTL) has been reached. The result is not available anymore. | Client error. | Internal server error.|\n\n\nIndicates if analyzer results should preview already created outputs while the analyzer is still running.
Set to false if only the final result is needed.
|\n|config.timeoutSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The amount of seconds to wait for the response to be returned.
The timeout controls how long the client is willing to wait, while the analyzer execution continues running until it has finished or is cancelled.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[AnalyzerExecuteResult](#analyzerexecuteresult)|200|The final analyzer result and execution status.|\n|[AnalyzerExecuteResult](#analyzerexecuteresult)|202|The current analyzer execution status and a request token and time-to-live (TTL) to continue polling the result with.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|AnalyzerErrorEnvelopeError|Invalid or malformed request. | Insufficient permissions. | No analyzer available with the requested name. | Client error. | Internal server error.|\n\n\nThe request token is returned when starting a long-running analyzer execution. It can be used to do follow-up operations like polling and cancelling.
|\n|config.timeoutSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The amount of seconds to wait for the response to be returned.
The timeout controls how long the client is willing to wait, while the analyzer execution continues running until it has finished or is cancelled.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[AnalyzerPollResult](#analyzerpollresult)|200|The current analyzer execution status and an optional partial result.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|AnalyzerErrorEnvelopeError|Invalid or malformed request. | Insufficient permissions. | No analyzer available with the requested name. | The analyzer result with the request token has already been consumed or its time-to-live (TTL) has been reached. The result is not available anymore. | Client error. | Internal server error.|\n\n\nSpecify which meta-information to fetch in addition to the default fields name, displayName and description.
Valid values are:
analyzerCallbaseAnalyzercategoryinputlabelsoutputtypeAny other field will result in a HTTP 400 response.
|\n|config.filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Use the filter parameter to only fetch a subset of analyzer definitions.
When using the operators =and !=, filtering is case sensitive.
The following operators are supported:
=!=containsstarts-withends-withandorParenthesis and the not operator are currently not supported.
The following fields are valid filtering parameters:
baseAnalyzerdescriptiondisplayNamelabelsnametypeAny other field will result in a HTTP 400 response.
|\n|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The cursor for the page of results. Find it in the nextPageKey field of the previous response.
If the page-key parameter is used, no other query parameters must be provided.
If not provided, the first page is always returned.
|\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The amount of returned analyzer definitions in a single response payload. By default, 50 is used. The maximum is 200.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[AnalyzerQueryResult](#analyzerqueryresult)|200|All available analyzer definitions.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|AnalyzerErrorEnvelopeError|Insufficient permissions. | Client error. | Internal server error.|\n\n\nThe request token is returned when starting a long-running analyzer execution. It can be used to do follow-up operations like polling and cancelling.
|\n|result*required|AnalyzerResult| |\n|ttlInSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Time-to-live until the result is not available anymore. |\n\n### AnalyzerCategory\n\nThe category of an analyzer used to logically group different analyzers.\n\n| Name | Type |\n| --- | --- |\n|displayName*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\n\n### AnalyzerData\n\nThe map of actual data matching the input and output definition of the analyzer.\n\n**type**: Record<string, any>\n\n### AnalyzerDefinition\n\nThe definition of the analyzer. It describes which input and output data the analyzer accepts\nand produces when being executed.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|baseAnalyzer|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The analyzer name that the current analyzer is based on. All input and output parameters are inherited. Additional parameters may be present in the current analyzer.
|\n|category|AnalyzerCategory|The category of an analyzer used to logically group different analyzers. |\n|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Detailed description of the analyzers' functionality. Get the documentation of the analyzer for more information.
|\n|displayName*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |\n|input|Array<ParameterDefinition>| |\n|labels|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of string-based labels to group and mark different analyzers. |\n|name*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The uniquely identifying name of the analyzer. |\n|output|Array<ParameterDefinition>| |\n|type|\"IMPLEMENTED\" | \"INTERFACE\"|The type of the analyzer.
The analyzer name that the current analyzer is based on. All input and output parameters are inherited. Additional parameters may be present in the current analyzer.
|\n|category|AnalyzerCategory|The category of an analyzer used to logically group different analyzers. |\n|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Detailed description of the analyzers' functionality. Get the documentation of the analyzer for more information.
|\n|displayName*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |\n|input|Array<ParameterDefinition>| |\n|labels|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of string-based labels to group and mark different analyzers. |\n|name*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The uniquely identifying name of the analyzer. |\n|output|Array<ParameterDefinition>| |\n|type|\"IMPLEMENTED\" | \"INTERFACE\"|The type of the analyzer.
The request token is returned when starting a long-running analyzer execution. It can be used to do follow-up operations like polling and cancelling.
|\n|result*required|AnalyzerResult| |\n|ttlInSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Time-to-live until the result is not available anymore. |\n\n### AnalyzerExecutionLog\n\n| Name | Type | Description |\n| --- | --- | --- |\n|level*required|\"TRACING\" | \"INFO\" | \"WARNING\" | \"SEVERE\"|Determines the severity of the log. |\n|message*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |\n|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A path pointing to the source of the error in the input. The format of the path follows the JSON path specification.
|\n\n### AnalyzerGeneralParameters\n\nParameters that are present in all analyzer input parameter definitions.\n\n| Name | Type | Default |\n| --- | --- | --- |\n|logVerbosity|\"TRACING\" | \"INFO\" | \"WARNING\" | \"SEVERE\"|\"WARNING\"|\n|resolveDimensionalQueryData|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false|\n|timeframe|Timeframe| |\n\n### AnalyzerInput\n\nThe input is specific to an analyzer. Get the definition of the analyzer to retrieve the required input structure.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|generalParameters|AnalyzerGeneralParameters|Parameters that are present in all analyzer input parameter definitions. |\n\n### AnalyzerOutput\n\nThe output is specific to an analyzer. Get the definition of the analyzer to retrieve the required output structure.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|system|AnalyzerOutputSystemParameters|Parameters that are present in all analyzer output parameter definitions. |\n\n### AnalyzerOutputLog\n\n| Name | Type |\n| --- | --- |\n|level*required|\"TRACING\" | \"INFO\" | \"WARNING\"| \n|message*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\n\n### AnalyzerOutputSystemParameters\n\nParameters that are present in all analyzer output parameter definitions.\n\n| Name | Type |\n| --- | --- |\n|logs|Array<AnalyzerOutputLog>|\n\n### AnalyzerPollResult\n\nResult of polling the analyzer execution.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|requestToken|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request token is returned when starting a long-running analyzer execution. It can be used to do follow-up operations like polling and cancelling.
|\n|result*required|AnalyzerResult| |\n|ttlInSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Time-to-live until the result is not available anymore. |\n\n### AnalyzerQueryResult\n\nThe list of available analyzers.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|analyzers*required|Array<AnalyzerDefinition>| |\n|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key that should be used to do follow-up requests, fetching the remaining analyzers. If the last page is reached or all analyzers are already listed, this field is omitted.
|\n|totalCount*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total amount of analyzers available opposed to the current page size. |\n\n### AnalyzerResult\n\n| Name | Type | Description |\n| --- | --- | --- |\n|data|Array<AnalyzerDimensionalData>| |\n|executionStatus*required|\"RUNNING\" | \"ABORTED\" | \"COMPLETED\"| |\n|input*required|AnalyzerInput|The input is specific to an analyzer. Get the definition of the analyzer to retrieve the required input structure. |\n|logs|Array<AnalyzerExecutionLog>| |\n|output*required|Array<AnalyzerOutput>| |\n|resultId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The uniquely identifying ID of the result. Used for logging. |\n|resultStatus*required|\"SUCCESSFUL\" | \"SUCCESSFUL_WITH_WARNINGS\" | \"FAILED\"| |\n\n### AnalyzerValidationResult\n\nThe result of the dry-execution of the analyzer.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|details|AnalyzerErrorDetails| |\n|valid*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether the analyzer can be successfully executed with the given input data. |\n\n### ConstraintViolation\n\nA constraint violation indicating why an error has occurred.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|level*required|\"TRACING\" | \"INFO\" | \"WARNING\" | \"SEVERE\"|Determines the severity of the log. |\n|message*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |\n|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A path pointing to the source of the error in the input. The format of the path follows the JSON path specification.
|\n\n### EnumerationElement\n\nAn object that has a fixed set of possible values differentiated by the `key` property.\n\n| Name | Type |\n| --- | --- |\n|description*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| \n|displayName*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| \n|key*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\n\n### ParameterDefinition\n\nThe definition for a single parameter, describing its name and other meta information.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|advanced|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, this parameter is considered to be for advanced usage. |\n|array*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether this parameter can have an array of values. Passing a single, non-array value is also allowed. |\n|defaultValue|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)|The default value used when the parameter is omitted. |\n|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |\n|displayName*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |\n|enumerationValues|Array<EnumerationElement>| |\n|extendedType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Provides extended type information for this parameter. This allows additional semantics that can be utilized by analyzer consumers.
|\n|fields|Array<ParameterDefinition>|Given the parameter is of typestructure this property contains the sub-definition of the parameter. |\n|maxSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of elements if the parameter is an array. |\n|name*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |\n|optional*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether this parameter can be omitted when executing the analyzer. |\n|type*required|\"string\" | \"number\" | \"boolean\" | \"timeseriesArray\" | \"analyzerStructure\" | \"dimensionQuery\" | \"enumeration\" | \"integer\" | \"timeframe\" | \"timeseriesQuery\" | \"timestamp\"|The type of the parameter, indicating the format of the value to be provided. |\n|valueConstraints|ParameterDefinitionValueConstraints|Defines value constraints for string or number parameters. Not applicable to other parameter types. |\n\n### Timeframe\n\n| Name | Type | Description |\n| --- | --- | --- |\n|endTime|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Specify the end time in either absolute or relative format. For absolute format, use the ISO 8601 format (yyyy-MM-ddTHH:mm:ssZ). For relative format, use 'now' for the current time or apply an offset with the available units: 's' for seconds, 'm' for minutes, 'h' for hours, and 'd' for days. For example, use 'now-2h' or '-2h' for a relative offset of 2 hours. If not specified, defaults to now.
|\n|startTime*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Specify the start time in either absolute or relative format. For absolute format, use the ISO 8601 format (yyyy-MM-ddTHH:mm:ssZ). For relative format, use 'now' for the current time or apply an offset with the available units: 's' for seconds, 'm' for minutes, 'h' for hours, and 'd' for days. For example, use 'now-2h' or '-2h' for a relative offset of 2 hours.
|\n\n### DimensionQuery\n\nA query for dimensional data such as timeseries, entities, or logs.\n\n**type**: [string](https://developer.mozilla.org/en-US/docs/Glossary/String) | object\n\n## Enums\n\n\n### ~~AnalyzerDefinitionType~~\n\n> ⚠️ **Deprecated**\n> Use literal values.\n\n