FacetResult interface

Successfully executed facet containing additional statistics on the response of a query.

Extends

Properties

count

Number of records returned in the facet response.

data

A JObject array or Table containing the desired facets. Only present if the facet is valid.

resultType

Polymorphic discriminator, which specifies the different types this object can be

totalRecords

Number of total records in the facet results.

Inherited Properties

expression

Facet expression, same as in the corresponding facet request.

Property Details

count

Number of records returned in the facet response.

count: number

Property Value

number

data

A JObject array or Table containing the desired facets. Only present if the facet is valid.

data: Record<string, unknown>

Property Value

Record<string, unknown>

resultType

Polymorphic discriminator, which specifies the different types this object can be

resultType: "FacetResult"

Property Value

"FacetResult"

totalRecords

Number of total records in the facet results.

totalRecords: number

Property Value

number

Inherited Property Details

expression

Facet expression, same as in the corresponding facet request.

expression: string

Property Value

string

Inherited From Facet.expression