---
title: "AbstractFacetedSearchResultCollection"
url: "https://developer-qual.migros.ch/apis/products-8/versions/00c884ba-74fc-4f15-85ef-be7612933198/schemas/AbstractFacetedSearchResultCollection"
---

> Full API specification: https://developer-qual.migros.ch/apis/products-8/versions/00c884ba-74fc-4f15-85ef-be7612933198.md

# AbstractFacetedSearchResultCollection

A collection of search result instances with facets.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Products
  version: "8"
servers:
  - description: Public Kong Gateway URL
    url: https://api-qual.migros.ch
components:
  schemas:
    AbstractSearchResultCollection:
      allOf:
        - $ref: "#/components/schemas/AbstractCollection"
        - properties:
            ids:
              description: >-
                Ids only.


                Is filled instead of the usual property for content, with only
                the ids when a call is made with verbosity=id on a

                route that supports it.
              items:
                type: string
              type: array
            total_hits:
              description: >-
                The total hits may exceed the actual count of results in the
                collection.


                It represents the total number of results of a search and not
                only the

                potentially paginated subset.
              nullable: true
              type: integer
          type: object
      description: A collection of search result instances.
      type: object
    Facet:
      properties:
        name:
          description: Name of this facet.
          type: string
        terms:
          description: List of terms.
          items:
            $ref: "#/components/schemas/FacetTerm"
          type: array
      required:
        - name
        - terms
      type: object
    AbstractCollection:
      description: A generic collection of elements.
    FacetTerm:
      properties:
        active:
          description: Whether that facet has been used for the current response or not.
          nullable: true
          type: boolean
        count:
          description: Amount of items with that facet.
          type: integer
        name:
          description: Translated name.
          type: string
        slug:
          nullable: true
          type: string
        term:
          description: Term identifier.
          type: string
      required:
        - term
        - count
      type: object
    AbstractFacetedSearchResultCollection:
      allOf:
        - $ref: "#/components/schemas/AbstractSearchResultCollection"
        - properties:
            facets:
              additionalProperties:
                $ref: "#/components/schemas/Facet"
              deprecated: true
              description: Facets array.
              type: object
          type: object
      description: A collection of search result instances with facets.
      type: object
```