Skip to main content

FilterCoverage

How much of the tenant's attribute set is represented by the filters on a search result.

Reports how many attribute descriptions were available for this request and whether the configured limit prevented all of them from being considered, so an empty filters list caused by the limit can be told apart from one caused by no attributes applying to the result set.

type FilterCoverage {
  limit: Int!
  totalMatching: Int!
  truncated: Boolean!
}

Fields​

FilterCoverage.limit ● Int! non-null scalar​

Maximum number of attribute descriptions considered when building filters.

FilterCoverage.totalMatching ● Int! non-null scalar​

Number of attribute descriptions matching the criteria of this request, before the limit was applied.

This counts whatever the request asked for: with input: { isSearchable: true } it is the number of searchable attributes, with input: { ids: [...] } it is the number of matching ids.

FilterCoverage.truncated ● Boolean! non-null scalar​

True when attributes were left out because of the limit.

Pass input.ids to request filters for specific attributes regardless of the limit.

Member Of​

ProductsResponse object ● SparePartsResponse object