IInsightsQueryOptions
Configuration options for querying insights
export interface IInsightsQueryOptions
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (Optional) Filter insights by their author. The value of this property is URI of the author. | ||
number | (Optional) Specify number of items per page. Default: 50 | ||
boolean | (Optional) Specify if information about the users that created/modified the insights should be loaded for each insight. | ||
number | (Optional) Specify (zero-based) starting offset for the results. Default: 0 | ||
(Optional) Specify ordering of the insights. Default: natural ordering provided by the analytical backend. Note: this may differ between backend implementations. | |||
string | (Optional) Filter insights by their title |
Property details
IInsightsQueryOptions.authorproperty
Filter insights by their author. The value of this property is URI of the author.
author?: string;
IInsightsQueryOptions.limitproperty
Specify number of items per page. Default: 50
limit?: number;
IInsightsQueryOptions.loadUserDataproperty
Specify if information about the users that created/modified the insights should be loaded for each insight.
loadUserData?: boolean;
Remarks
Defaults to false.
IInsightsQueryOptions.offsetproperty
Specify (zero-based) starting offset for the results. Default: 0
offset?: number;
IInsightsQueryOptions.orderByproperty
Specify ordering of the insights. Default: natural ordering provided by the analytical backend. Note: this may differ between backend implementations.
orderBy?: InsightOrdering;
IInsightsQueryOptions.titleproperty
Filter insights by their title
title?: string;