pandagg.interactive.response module

class pandagg.interactive.response.IResponse(tree, client=None, index_name=None, root_path=None, depth=None, initial_tree=None, query=None)[source]

Bases: pandagg.interactive.abstract.TreeBasedObj

Interactive aggregation response.

get_bucket_filter()[source]

Build filters to select documents belonging to that bucket

list_documents(size=None, execute=True, _source=None, compact=False, **kwargs)[source]

Return ES aggregation query to list documents belonging to given bucket. :param size: number of returned documents (ES default: 20) :param execute: if set to False, return aggregation query :param _source: list of desired documents attributes :param compact: provide more compact ES response :param kwargs: query arguments passed to aggregation body :return: