Result object

When you execute a query, a DataContainer object is returned. This object encapsulates the query results along with metadata about the query. Additionally, it provides a suite of utility methods for accessing the results in various ways.

In a Python notebook environment, the DataContainer object can render a preview of its data, facilitating quick inspection of the query results.

impresso.data_container.DataContainer

Bases: Generic[IT, T]

Generic container for responses from the Impresso API returned by resource methods (get, find). Generally represents a single page of the result.

df: DataFrame property

Returns the response data as a pandas dataframe.

limit: int property

Current page size.

offset: int property

Current page offset.

pydantic: T property

Returns the response data as a pydantic model.

raw: dict[str, Any] property

Returns the response data as a python dictionary.

size: int property

Current page size.

total: int property

Total number of results.

url: str | None property

URL of an Impresso web application page representing the result set from this container.