query.analytics

Analytics query

type	object
properties
isTemplateGeneratedByOspComposer	Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.
	type	string
moduleId	The id of the analytics module to attach this query to
	type	string
query	Expression that represents the data to fetch.
	QueryEntity
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
additionalProperties	False

QueryEntity

type	object
properties
additionalStages	List of additional stages to add at the end of the query
	type	array
	items	type	string
aggregate	Define a aggregation function
	QueryAggregateConfigurationEntity
collection	The name of the collection
	type	string
fields	List of fields we want to get
	type	array
	items	type	string
limit	Set limit number of results
	QueryLimitConfigurationEntity
measurements	List of measurements we want to get
	type	array
	items	type	string
range	Time period of the query Default value is [{“start”:{“unit”:”SECONDS”,”value”:60}}]
	default	start	unit	SECONDS
			value	60
	QueryRangeConfigurationEntity
additionalProperties	False

QueryAggregateConfigurationEntity

type	object
properties
every	Aggregation window (default is 1h). Default value is [{“unit”:”HOURS”,”value”:1}]
	default	unit	HOURS
		value	1
	DurationConfigurationEntity
fn	Aggregation function (mean as default). Default value is [“mean”]
	type	string
	enum	count, integral, last, mean, median, min, max
	default	mean
additionalProperties	False

DurationConfigurationEntity

type	object
properties
unit	The unit of time expressed
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
value	The amount of time expressed with the unit
	type	integer
additionalProperties	False

QueryLimitConfigurationEntity

type	object
properties
from	Takes the x results from the first or the last value (default value). Default value is [“Last”]
	type	string
	enum	First, Last
	default	Last
limit	Limit number of results
	type	integer
offset	Offset
	type	integer
additionalProperties	False

QueryRangeConfigurationEntity

type	object
properties
end	End
	DurationConfigurationEntity
start	Start
	DurationConfigurationEntity
additionalProperties	False