CatalogSearchMetricsResponse

pydantic model openapi_client.models.catalog_search_metrics_response.CatalogSearchMetricsResponse

Reduced search response returned when the get_metrics query parameter is “true”. Only facet counts and the total are returned; there is no Results array and no pagination keys. Use it to populate filter controls before running the real search.

Fields:

• metrics (Dict[str, Dict[str, int]])

• total_count (int)

field metrics: Dict[str, Dict[str, StrictInt]] [Required] (alias 'Metrics')

Facet counts, keyed by facet field and then by value, over the same facet fields listed on CatalogSearchResponse.

field total_count: StrictInt [Required]

Total number of assets matching the search.

Constraints:

• strict = True

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of CatalogSearchMetricsResponse from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of CatalogSearchMetricsResponse from a dict

Return type:

Optional[Self]