Skip to content

SearchFacetsOutput

Source code in docs_src/capo_marketplace_discovery/types/search_facets_output.py 
15
16
17
18
19
20
21
22
23
class SearchFacetsOutput(TypedDict, closed=True):
    total_results: (
        "capo_marketplace_discovery.types.non_negative_count.NonNegativeCount"
    )
    """<p>The total number of listings matching the search criteria.</p>"""
    listing_facets: "capo_marketplace_discovery.types.type_to_facet_map.TypeToFacetMap"
    """<p>A map of facet types to their corresponding facet values. Each facet value includes a display name, internal value, and count of matching listings.</p>"""
    next_token: NotRequired["capo_marketplace_discovery.types.next_token.NextToken"]
    """<p>If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token to retrieve the next page.</p>"""

listing_facets instance-attribute 

listing_facets: TypeToFacetMap

A map of facet types to their corresponding facet values. Each facet value includes a display name, internal value, and count of matching listings.

next_token instance-attribute 

next_token: NotRequired[NextToken]

If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

total_results instance-attribute 

total_results: NonNegativeCount

The total number of listings matching the search criteria.