IDateFilterConfigsQuery
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
This service provides access to workspace date filter configs (also known as extended date filters). Date filter configs allow to define your own date filter presets, that appear in the date filter. To make date filter configs work, you have to set enableKPIDashboardExtendedDateFilters feature flag to true.
export interface IDateFilterConfigsQuery
Methods
Method | Description |
|---|---|
(ALPHA) Starts the date filter configs query. | |
(ALPHA) Starts the custom date filter confis by settings query. | |
(ALPHA) Sets number of date filter configs to return per page. Default/max limit is specific per backend | |
(ALPHA) Sets starting point for the query. Backend WILL return no data if the offset is greater than total number of date filter configs Default offset: 0 |
Method details
IDateFilterConfigsQuery.query()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Starts the date filter configs query.
query(): Promise<IDateFilterConfigsQueryResult>;
Returns
Promise<IDateFilterConfigsQueryResult>
promise of first page of the results
IDateFilterConfigsQuery.queryCustomDateFilterConfig()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Starts the custom date filter confis by settings query.
queryCustomDateFilterConfig(): Promise<IDateFilterConfigsQueryResult>;
Returns
Promise<IDateFilterConfigsQueryResult>
promise of first page of the results
IDateFilterConfigsQuery.withLimit()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Sets number of date filter configs to return per page. Default/max limit is specific per backend
withLimit(limit: number): IDateFilterConfigsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
limit | number | desired max number of date filter configs per page; must be a positive number |
Returns
date filter configs query
IDateFilterConfigsQuery.withOffset()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Sets starting point for the query. Backend WILL return no data if the offset is greater than total number of date filter configs Default offset: 0
withOffset(offset: number): IDateFilterConfigsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
offset | number | zero indexed, must be non-negative |
Returns
date filter configs query