Explorer (REST)¶

All JSON APIs live under /api/v1/explorer/*. Product concepts: Data Explorer.

These routes are registered only in the Professional binary. Basic Data Explorer, including query, statistics, spatial analysis, and saved views, is allowed before a license is activated. Dashboard widget routes check feature dashboards and stay denied until a Report Server Professional license is valid. The Open Source package does not mount /api/v1/explorer/*.

Discover metadata¶

curl -sS -H "Authorization: Bearer $ACUGIS_REPORT_TOKEN" \
  "$ACUGIS_REPORT_URL/api/v1/explorer/datasources"

curl -sS -H "Authorization: Bearer $ACUGIS_REPORT_TOKEN" \
  "$ACUGIS_REPORT_URL/api/v1/explorer/tables?datasource=reporting_db"

curl -sS -H "Authorization: Bearer $ACUGIS_REPORT_TOKEN" \
  "$ACUGIS_REPORT_URL/api/v1/explorer/metadata?datasource=reporting_db&schema=public&table=parcels"

Run a query¶

POST /api/v1/explorer/query — server-side filter / group / aggregate / sort / page.

curl -sS -H "Authorization: Bearer $ACUGIS_REPORT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"datasource":"reporting_db","schema":"public","table":"parcels","columns":["id","name"],"limit":50}' \
  "$ACUGIS_REPORT_URL/api/v1/explorer/query"

Report query¶

POST /api/v1/explorer/report-query executes a report’s main query through Jasper and caches the result for Explorer widgets.

Features (GeoJSON)¶

POST /api/v1/explorer/features returns GeoJSON for map widgets (PostGIS or report geometry).

Export¶

POST /api/v1/explorer/export?format=csv|excel|geojson|gpkg|shapefile

curl -sS -H "Authorization: Bearer $ACUGIS_REPORT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"datasource":"reporting_db","schema":"public","table":"parcels","columns":["id","name"]}' \
  "$ACUGIS_REPORT_URL/api/v1/explorer/export?format=csv" -o parcels.csv

gpkg and shapefile responses are ZIP binaries.

Summary & statistics¶

POST /api/v1/explorer/summary
POST /api/v1/explorer/statistics (runExplorerStatistics)

Spatial analysis¶

Method	Path	Purpose
`POST`	`/api/v1/explorer/spatial-analysis`	Run analysis
`POST`	`/api/v1/explorer/spatial-analysis/validate`	Geometry / SRID validation
`GET`	`/api/v1/explorer/spatial-analysis/capabilities`	Supported analyses

Map helpers: /api/v1/explorer/map/sources, /tables, /discover.

Saved views & dashboards¶

Method	Path	Purpose
`GET`	`/api/v1/explorer/views`	List my views
`POST`	`/api/v1/explorer/views`	Save / upsert
`GET`	`/api/v1/explorer/views/{key}`	Load
`DELETE`	`/api/v1/explorer/views/{key}`	Delete
`POST`	`/api/v1/explorer/views/{key}/dashboard`	Flag as dashboard widget
`GET`	`/api/v1/explorer/dashboard-widgets`	List dashboard refs

Handoff¶

POST /api/v1/explorer/handoff builds a Report Builder payload from the current Explorer state. No JRXML is written by Explorer.