HomeGuidesAPI ReferenceChangelog
Log In
API Reference

SearchQuery

generic class to represent a JSON request structure for searching entities with filters, sorting and pagination.

Attributes

NameTypeDescription
filtersdictdictionary of filter criteria where keys are field names and values are FilterOperator expressions.
sortlistlist of SortOption defining sorting rules.
pageintpage number for pagination.
sizeintnumber of results per page.
limitintmaximum number of results to return.
service_namestrname of the service to query.
groupslistlist of group options for aggregation.
group_summarieslistlist of group summaries for aggregation statistics.

Methods

from_dict()

create a SearchQuery from a dictionary.

NameTypeDefaultDescription
datadictdictionary representation of the search query.

to_dict()

convert SearchQuery to a dictionary.

return: dictionary representation.