Reports API

The Reports API provides programmatic access to any report configured on your Eclipse tenant. Reports are identified by a reportId string and accept typed query parameters that are passed through to the underlying SQL query.

Endpoint

GET /eclipse-conductor/rest/v1/tenants/{tenantId}/reports/{reportId}
Authorization: Bearer {jwt}

View in API Reference

Query Parameters

Parameters are typed and positionally named. Each report uses a subset of them — see the Standard Reports catalogue for exactly which parameters each report expects.

Parameter	Type	Description
`d1`–`d8`	String	Date filters. ISO 8601 format: `YYYY-MM-DDTHH:mm:ss.SSS`
`s1`–`s20`	String	String filters — status codes, identifiers, names
`n1`–`n8`	Double	Numeric filters — accepts decimal values
`organisationId`	Long	Restricts results to a specific organisation within the tenant. Omit to return data across all organisations
`format`	String	Output format: `json` (default), `csv`, `xml`, or `xls`
`streamResult`	Boolean	Set to `true` to generate the report asynchronously. Returns `204` immediately; report is delivered when ready. Default: `false`
`deliveryMechanismType`	String	Delivery channel for async reports. Values: `email`, `http`, or `jira`. Required when `streamResult=true`
`deliveryMechanismValue`	String	The email address, callback URL, or Jira reference for delivery. Required when `streamResult=true`

Response Behaviour

Scenario	HTTP Status	Body
Results returned	`200 OK`	Report data in the requested format
Query returned no rows	`204 No Content`	Empty
`streamResult=true` submitted	`204 No Content`	Empty — report delivered asynchronously when ready

📘
Note
Synchronous requests have a 15-second timeout. If your report regularly hits this limit, use Asynchronous Report Delivery instead.

Output Formats

The format parameter controls how the response body is serialised.

Value	Content-Type	Notes
`json`	`application/json`	Default. Returns a JSON array of objects
`csv`	`text/csv`	Comma-separated, with a header row
`xml`	`application/xml`	XML document
`xls`	`application/vnd.ms-excel`	Excel workbook — useful for direct download

Examples

Fetch the Digital Wallet Transaction Detail report in CSV:

curl -s \
  "https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/11224145/reports/Report_digital_wallet_transaction_detail?d1=2024-01-01T00:00:00.000&d2=2024-02-01T00:00:00.000&format=csv" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -o wallet_transactions_jan2024.csv

Fetch the same report scoped to a specific organisation, in JSON:

curl -s \
  "https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/11224145/reports/Report_digital_wallet_transaction_detail?d1=2024-01-01T00:00:00.000&d2=2024-02-01T00:00:00.000&organisationId=98765" \
  -H "Authorization: Bearer $JWT_TOKEN"

Submit the same report as an async request with HTTP callback delivery:

curl -s \
  "https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/11224145/reports/Report_digital_wallet_transaction_detail?d1=2024-01-01T00:00:00.000&d2=2024-02-01T00:00:00.000&format=csv&streamResult=true&deliveryMechanismType=http&deliveryMechanismValue=https://myapp.example.com/webhooks/report-ready" \
  -H "Authorization: Bearer $JWT_TOKEN"
# Returns HTTP 204 immediately; report delivered to webhook when ready

Using the Admin Portal

You can run any report directly from the Eclipse admin portal without writing any code:

Log in to the Eclipse admin portal
Navigate to the Reports section and select a report category
Select a report and enter any required parameters
Click Generate Report. Results appear at the bottom of the page. Download in CSV, JSON, XML, or XLS format.

For large reports that time out in the portal, the admin portal also supports streaming — see Asynchronous Report Delivery.

Report streaming in the Eclipse Admin Portal