Skip to content

Latest commit

 

History

History
38 lines (36 loc) · 5.36 KB

ChartDataQueryObject.md

File metadata and controls

38 lines (36 loc) · 5.36 KB
Raw

SwaggerClient::ChartDataQueryObject

Properties

Name Type Description Notes
annotation_layers Array<AnnotationLayer> Annotation layers to apply to chart [optional]
applied_time_extras Object A mapping of temporal extras that have been applied to the query [optional]
apply_fetch_values_predicate BOOLEAN Add fetch values predicate (where clause) to query if defined in datasource [optional]
columns Array<null> Columns which to select in the query. [optional]
datasource AllOfChartDataQueryObjectDatasource [optional]
druid_time_origin String Starting point for time grain counting on legacy Druid datasources. Used to change e.g. Monday/Sunday first-day-of-week. This field is deprecated and should be passed to `extras` as `druid_time_origin`. [optional]
extras AllOfChartDataQueryObjectExtras Extra parameters to add to the query. [optional]
filters Array<ChartDataFilter> [optional]
granularity String Name of temporal column used for time filtering. For legacy Druid datasources this defines the time grain. [optional]
granularity_sqla String Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use `granularity` instead. [optional]
groupby Array<null> Columns by which to group the query. This field is deprecated, use `columns` instead. [optional]
having String HAVING clause to be added to aggregate queries using AND operator. This field is deprecated and should be passed to `extras`. [optional]
having_filters Array<ChartDataFilter> HAVING filters to be added to legacy Druid datasource queries. This field is deprecated and should be passed to `extras` as `having_druid`. [optional]
is_rowcount BOOLEAN Should the rowcount of the actual query be returned [optional]
is_timeseries BOOLEAN Is the `query_object` a timeseries. [optional]
metrics Array<null> Aggregate expressions. Metrics can be passed as both references to datasource metrics (strings), or ad-hoc metricswhich are defined only within the query object. See `ChartDataAdhocMetricSchema` for the structure of ad-hoc metrics. [optional]
order_desc BOOLEAN Reverse order. Default: `false` [optional]
orderby Array<null> Expects a list of lists where the first element is the column name which to sort by, and the second element is a boolean. [optional]
post_processing Array<AllOfChartDataQueryObjectPostProcessingItems> Post processing operations to be applied to the result set. Operations are applied to the result set in sequential order. [optional]
result_type **** [optional]
row_limit Integer Maximum row count (0=disabled). Default: `config[&quot;ROW_LIMIT&quot;]` [optional]
row_offset Integer Number of rows to skip. Default: `0` [optional]
series_columns Array<null> Columns to use when limiting series count. All columns must be present in the `columns` property. Requires `series_limit` and `series_limit_metric` to be set. [optional]
series_limit Integer Maximum number of series. Requires `series` and `series_limit_metric` to be set. [optional]
series_limit_metric **** Metric used to limit timeseries queries by. Requires `series` and `series_limit` to be set. [optional]
time_offsets Array<String> [optional]
time_range String A time rage, either expressed as a colon separated string `since : until` or human readable freeform. Valid formats for `since` and `until` are: - ISO 8601 - X days/years/hours/day/year/weeks - X days/years/hours/day/year/weeks ago - X days/years/hours/day/year/weeks from now Additionally, the following freeform can be used: - Last day - Last week - Last month - Last quarter - Last year - No filter - Last X seconds/minutes/hours/days/weeks/months/years - Next X seconds/minutes/hours/days/weeks/months/years [optional]
time_shift String A human-readable date/time string. Please refer to parsdatetime documentation for details on valid values. [optional]
timeseries_limit Integer Maximum row count for timeseries queries. This field is deprecated, use `series_limit` instead.Default: `0` [optional]
timeseries_limit_metric **** Metric used to limit timeseries queries by. This field is deprecated, use `series_limit_metric` instead. [optional]
url_params Hash<String, String> Optional query parameters passed to a dashboard or Explore view [optional]
where String WHERE clause to be added to queries using AND operator.This field is deprecated and should be passed to `extras`. [optional]