Skip to content

Explorer queries

Build and run filtered queries against a table or a cached report result set from the Data Explorer canvas.

These APIs exist on the Professional package, including before a license is activated. They are not in the Open Source package. Dashboard actions on the same routes are a separate license check.

Discover data

In the UI, choose a datasource, schema, and table (or switch to Report Query mode). Metadata discovery populates columns for filters, charts, and maps.

Run a query

Apply filters, columns, sort, and row limits on the shared dataset. Widgets then consume that dataset. Group-by and aggregates typically live on Chart / Summary / Crosstab / Statistics widgets rather than rewriting every widget.

Report query mode

Report Query mode executes a report’s main JRXML <query> through Jasper and caches the result for Explorer widgets. Subdatasets and layout are ignored.

Features and maps

Map widgets can request GeoJSON features from PostGIS tables or report geometry columns.

Export

Export the current query result to CSV, Excel, GeoJSON, GeoPackage, or Shapefile without generating JRXML.

Summary

Summary aggregations (count/sum/avg/min/max/median/distinct and related stats) power Summary widgets.

Handoff

Handoff builds a Report Builder payload from the current Explorer state. No JRXML is written by Explorer.


For Developers

Detailed endpoint examples (curl, CLI, request bodies) live in the Developer Guide.

Integration path Go here
Explorer REST examples REST Explorer
CLI CLI explorer
OpenAPI OpenAPI