IItemQueryMetricSource

Interface

Defines a metric source that fetches values from a set of items.

Properties

Property Type Notes
keywords string[]

Keywords used in the query to search for items

propertyPath string

Property path to get the value from the item e.g. properties.numComments or properties.metrics[findBy(id,'funding_00c')].source

type "item-query"
collectionKey Optional string

Key of the collection to further limit the search This is resolved into an IQuery in the pre-processing step. If not defined, only the keyword and item types are used.

itemTypes Optional string[]

Item types to limit the search

scope Optional IQuery

Scope query. This will be pulled from the collection if collectionKey is defined.


Interface defined in common/src/core/types/Metrics.ts:140