IInsightsQueryOptions

Home > @gooddata/sdk-backend-spi > IInsightsQueryOptions

IInsightsQueryOptions interface

Configuration options for querying insights

Signature:

export interface IInsightsQueryOptions

Properties

Property

Modifiers

Type

Description

author?

string

(Optional) Filter insights by their author. The value of this property is URI of the author.

limit?

number

(Optional) Specify number of items per page. Default: 50

loadUserData?

boolean

(Optional) Specify if information about the users that created/modified the insights should be loaded for each insight.

offset?

number

(Optional) Specify (zero-based) starting offset for the results. Default: 0

orderBy?

InsightOrdering

(Optional) Specify ordering of the insights. Default: natural ordering provided by the analytical backend. Note: this may differ between backend implementations.

title?

string

(Optional) Filter insights by their title

← IInsightsQueryIInsightsQueryResult →