Web API: Expression/query - Revision history

Ollvihe: /* Request */

2025-03-27T22:27:57Z

Request

← Older revision		Revision as of 22:27, 27 March 2025
Line 6:		Line 6:
	The request endpoint url is '''qprpa/api/expression/query''' and there are optional ResponseType and StringifyValues url parameters (see more in the [[#Response\|response chapter]]. The payload of the request is a JSON object which properties are described in the [[#Query\|query chapter]]. Example query:		The request endpoint url is '''qprpa/api/expression/query''' and there are optional ResponseType and StringifyValues url parameters (see more in the [[#Response\|response chapter]]. The payload of the request is a JSON object which properties are described in the [[#Query\|query chapter]]. Example query:
	<pre>		<pre>
	Url: POST /api/expression/query?ResponseType=object&StringifyValues=~~false~~		Url: POST /api/expression/query?ResponseType=object&StringifyValues=true
	Content-Type: application/json;charset=UTF-8		Content-Type: application/json;charset=UTF-8
	Body:		Body:

Ollvihe: /* Properties */

2024-08-07T11:30:17Z

Properties

← Older revision		Revision as of 11:30, 7 August 2024
Line 238:		Line 238:
	\|-		\|-
	\|\|Queries		\|\|Queries
	\|\|Performs several "subqueries" within one query. Contains an array of full or partial queries for each of the subqueries. ~~Each subquery is merged to~~ the top-level ~~"base~~ query~~" with following~~ rules:		\|\|Performs several "subqueries" within one "top-level query". Contains an array of full or partial queries for each of the subqueries. The actual queries are constructed by taking the top-level query as a basis and adding fields defined in the subquery. Following rules are applied:
	* Arrays are always replaced completely. For example, it's not possible to add or remove individual ~~Value columns~~ in the subquery.		* Arrays are always replaced completely. For example, it's not possible to add or remove individual array items in the subquery.
	* ''null'' values are ignored, i.e., ~~using~~ a null value in the subquery will use a value in the ~~base~~ query.		* ''null'' values are ignored, i.e., having a null value in the subquery will use a value in the top-level query.
	* Additional column ''_QueryId'' is added to the result, indicating from which subquery the row originating from (integer index of the subquery starting from 0).
			Additional column ''_QueryId'' is added to the result, indicating from which subquery the row is originating from (integer index of the subquery starting from 0).

	If all subqueries use SqlDataFrames, the subqueries will be combined into one expression and SqlDataFrame that will be processed at once, instead of evaluating each query separately. If there is at least one query that does not return an SqlDataFrame, each query will be performed separately.		If all subqueries use SqlDataFrames, the subqueries will be combined into one expression and SqlDataFrame that will be processed at once, instead of evaluating each query separately. If there is at least one query that does not return an SqlDataFrame, each query will be performed separately.

Ollvihe: /* Properties */

2024-08-07T11:24:48Z

Properties

← Older revision		Revision as of 11:24, 7 August 2024
Line 238:		Line 238:
	\|-		\|-
	\|\|Queries		\|\|Queries
	\|\|~~Allows performing multiple~~ "subqueries" within one query. Contains an array of full or partial ~~query configurations~~ for the subqueries. ~~The result will be~~ the ~~results of performed each of these subqueries merged on~~ top ~~of the~~ base query with following rules:		\|\|Performs several "subqueries" within one query. Contains an array of full or partial queries for each of the subqueries. Each subquery is merged to the top-level "base query" with following rules:
	* Arrays are always replaced completely~~, e.g~~., it is not possible to add or remove a Value ~~column defined~~ in ~~the top-level query just by configuring~~ the subquery ~~configuration~~.		* Arrays are always replaced completely. For example, it's not possible to add or remove individual Value columns in the subquery.
	* ''null'' values are ignored, e.g., ~~giving~~ null ~~as the~~ value ~~of Values~~ in subquery will ~~result into~~ a ~~query where Values is taken from~~ the ~~top-level~~ query.		* ''null'' values are ignored, i.e., using a null value in the subquery will use a value in the base query.
	* Additional column ''_QueryId'' is added to the result, indicating which subquery the row ~~is result of as an~~ integer index of the subquery starting from 0.		* Additional column ''_QueryId'' is added to the result, indicating from which subquery the row originating from (integer index of the subquery starting from 0).

	If all ~~the~~ subqueries ~~result into queries that return~~ SqlDataFrames, the subqueries will be combined into one expression and SqlDataFrame that will be processed ~~all~~ at once, instead of evaluating each query separately. If there is at least one query that does not return SqlDataFrame, each query will be performed separately.		If all subqueries use SqlDataFrames, the subqueries will be combined into one expression and SqlDataFrame that will be processed at once, instead of evaluating each query separately. If there is at least one query that does not return an SqlDataFrame, each query will be performed separately.

	The following fields can't be set in subqueries: ModelId, FilterId (note: Filters can still be adjusted), ContextType, RuntimeComparison, Comparison, EnableResultCaching, QueryIdentifier, DashboardId, CancelEarlierQueriesWithIdentifier, ExplainQuery, EnableFilteredEventDataCaching.		The following fields can't be set in subqueries: ModelId, FilterId (note: Filters can still be adjusted), ContextType, RuntimeComparison, Comparison, EnableResultCaching, QueryIdentifier, DashboardId, CancelEarlierQueriesWithIdentifier, ExplainQuery, EnableFilteredEventDataCaching.

Ollvihe: /* Properties */

2024-08-07T11:13:04Z

Properties

← Older revision		Revision as of 11:13, 7 August 2024
Line 238:		Line 238:
	\|-		\|-
	\|\|Queries		\|\|Queries
	\|\|Allows performing multiple subqueries within one ~~top-level~~ query. ~~May contain~~ an array of full or partial query configurations~~. These are referred below as~~ subqueries. ~~If the array contains one or more subqueries, the end~~ result will ~~contain~~ the results of ~~queries~~ performed ~~using~~ each of these subqueries merged on top of the base-query with following rules:		\|\|Allows performing multiple "subqueries" within one query. Contains an array of full or partial query configurations for the subqueries. The result will be the results of performed each of these subqueries merged on top of the base query with following rules:
	* Arrays are always replaced completely, e.g., it is not possible to add or remove a Value-column defined in the top-level query ~~configuration~~ just by configuring the ~~sub-query~~ configuration.		* Arrays are always replaced completely, e.g., it is not possible to add or remove a Value column defined in the top-level query just by configuring the subquery configuration.
	* ''null'' values are ignored, e.g., giving null as the value of Values in ~~sub-query configuration~~ will result into a query ~~configuration~~ where Values~~-configuration~~ is taken from the top-level query ~~configuration.~~		* ''null'' values are ignored, e.g., giving null as the value of Values in subquery will result into a query where Values is taken from the top-level query.
	* The result is returned as a single table which is compiled by appending each sub-query result separately using IncludeAllColumns-mechanism.		* Additional column ''_QueryId'' is added to the result, indicating which subquery the row is result of as an integer index of the subquery starting from 0.
	* ~~An additional~~ column "_QueryId" is added to the result~~. This column indicates~~ which ~~sub query given~~ row is result of as an integer index of the ~~sub-query configuration in the full Queries-configuration~~ starting from 0.

	If all the subqueries result into queries that return SqlDataFrames, the ~~sub-queries~~ will be combined into one expression and SqlDataFrame that will be processed all at once, instead of evaluating each query separately. If there is at least one query that does not return SqlDataFrame, each query will be performed separately.		If all the subqueries result into queries that return SqlDataFrames, the subqueries will be combined into one expression and SqlDataFrame that will be processed all at once, instead of evaluating each query separately. If there is at least one query that does not return SqlDataFrame, each query will be performed separately.

	The following ~~configurations~~ can't be ~~adjusted~~ in ~~sub-queries~~: ModelId, FilterId (note: Filters can still be adjusted), ContextType, RuntimeComparison, Comparison, EnableResultCaching, QueryIdentifier, DashboardId, CancelEarlierQueriesWithIdentifier, ExplainQuery, EnableFilteredEventDataCaching		The following fields can't be set in subqueries: ModelId, FilterId (note: Filters can still be adjusted), ContextType, RuntimeComparison, Comparison, EnableResultCaching, QueryIdentifier, DashboardId, CancelEarlierQueriesWithIdentifier, ExplainQuery, EnableFilteredEventDataCaching.
	\|}		\|}

Ollvihe: /* Properties */

2024-08-07T10:53:21Z

Properties

@@ Line 236: / Line 236: @@
 ||CancelEarlierQueriesWithIdentifier
 ||Boolean value defining whether possible previous query with the same ''QueryIdentifier'' is cancelled when a new query with the same identifier is received by the server. The default value is ''false''.
 |}

Ollvihe: /* Values */

2023-01-27T15:55:31Z

Values

← Older revision		Revision as of 15:55, 27 January 2023
Line 376:		Line 376:
	\|\|		\|\|
	Expression whose result is used to fill the "gaps" of the matrix created when pivot value type is used.		Expression whose result is used to fill the "gaps" of the matrix created when pivot value type is used.
	\|-
	~~\|\|EvaluateAfterAggregations~~
	\|\|If set to ''true'', makes the value calculation occur only after dimension aggregations have been performed, thus making it possible to calculate values based on the already aggregated value or dimension columns. Available only in the DataFrame processing method.
	\|-		\|-
	\|\|IsHidden		\|\|IsHidden

Ollvihe: /* Values */

2023-01-27T15:55:03Z

Values

Ollvihe: /* Values */

2022-11-29T14:40:26Z

Values

← Older revision		Revision as of 14:40, 29 November 2022
Line 337:		Line 337:
	\|-		\|-
	\|\|NumberPrecision		\|\|NumberPrecision
	\|\|Same setting as in the [[#Dimensions]].		\|\|Same setting as in the [[#Dimensions\|Dimensions]].
	\|-		\|-
	\|\|DatetimeTruncation		\|\|DatetimeTruncation
	\|\|Same setting as in the [[#Dimensions]].		\|\|Same setting as in the [[#Dimensions\|Dimensions]].
	\|-		\|-
	\|\|TimespanPrecision		\|\|TimespanPrecision
	\|\|Same setting as in the [[#Dimensions]].		\|\|Same setting as in the [[#Dimensions\|Dimensions]].
	\|-		\|-
	\|\|ValueType		\|\|ValueType

Ollvihe: /* Values */

2022-11-29T14:40:00Z

Values

← Older revision		Revision as of 14:40, 29 November 2022
Line 335:		Line 335:
	"AggregationExpression": "\"(\" + Count(_) + \" others) \" + Min(_) + \" - \" + Max(_)"		"AggregationExpression": "\"(\" + Count(_) + \" others) \" + Min(_) + \" - \" + Max(_)"
	</pre>		</pre>
			\|-
			\|\|NumberPrecision
			\|\|Same setting as in the [[#Dimensions]].
			\|-
			\|\|DatetimeTruncation
			\|\|Same setting as in the [[#Dimensions]].
			\|-
			\|\|TimespanPrecision
			\|\|Same setting as in the [[#Dimensions]].
	\|-		\|-
	\|\|ValueType		\|\|ValueType

Ollvihe: /* Values */

2022-11-10T22:48:53Z

Values

← Older revision		Revision as of 22:48, 10 November 2022
Line 303:		Line 303:
	* '''Pivot''': Expression to produce an array, where each item represents a dynamically generated column. The result shown by the Expression query is number of items belonging to each column.		* '''Pivot''': Expression to produce an array, where each item represents a dynamically generated column. The result shown by the Expression query is number of items belonging to each column.
	\|-		\|-
	\|\|
	\|\|EvaluateAfterAggregation		\|\|EvaluateAfterAggregation
	When ''true'', the value expression is calculated after dimension aggregations have been performed. This makes it possible to calculate values based on the already aggregated value or dimension columns. Default value is ''false''. Applicable only for the Snowflake models.		\|\|When ''true'', the value expression is calculated after dimension aggregations have been performed. This makes it possible to calculate values based on the already aggregated value or dimension columns. Default value is ''false''. Applicable only for the Snowflake models.

	Expressions in the query are calculated in the following order:		Expressions in the query are calculated in the following order:

← Older revision		Revision as of 14:40, 29 November 2022
Line 337:		Line 337:
	\|-		\|-
	\|\|NumberPrecision		\|\|NumberPrecision
	\|\|Same setting as in the [[#Dimensions]].		\|\|Same setting as in the [[#Dimensions\|Dimensions]].
	\|-		\|-
	\|\|DatetimeTruncation		\|\|DatetimeTruncation
	\|\|Same setting as in the [[#Dimensions]].		\|\|Same setting as in the [[#Dimensions\|Dimensions]].
	\|-		\|-
	\|\|TimespanPrecision		\|\|TimespanPrecision
	\|\|Same setting as in the [[#Dimensions]].		\|\|Same setting as in the [[#Dimensions\|Dimensions]].
	\|-		\|-
	\|\|ValueType		\|\|ValueType