Back to Docs
API Reference
ReportBridge exposes a Lambda-based API through AWS API Gateway. All requests are JSON POST with an action field.
Request Format
POST /prod HTTP/1.1
Content-Type: application/json
{
"action": "ws-list-reports",
"api_key": "<your-api-key>",
"instance_id": "<your-instance>",
"page": 1,
"page_size": 50
}Admin— Requires admin API key
Viewer— Requires viewer API key or token
Tenant— Requires tenant-derived key
Public— No authentication (rate-limited)
Report Management
9 endpoints| Action | Description | Auth |
|---|---|---|
| ws-list-reports | List all reports in the workspace (paginated, tenant-scoped) | Admin |
| ws-get-report | Get report details including SQL and parameters | Admin |
| ws-extract-rdl | Upload and parse an RDL file into the workspace | Admin |
| ws-build-rdl | Rebuild RDL XML from workspace state | Admin |
| ws-clean-publish | Build RDL and publish to the report server | Admin |
| ws-delete-report | Delete a report from the workspace | Admin |
| ws-dashboard | Get workspace dashboard summary statistics | Admin |
| publish-report | Upload RDL directly to the report server | Admin |
| reconcile-catalog | Compare workspace catalog vs report server | Admin |
AI Conversion
7 endpoints| Action | Description | Auth |
|---|---|---|
| ws-convert-sql | AI convert T-SQL to PostgreSQL for a report dataset | Admin |
| ws-fix-sql | AI fix failing SQL using error context | Admin |
| ws-save-sql | Save converted SQL to workspace | Admin |
| ws-test-dataset | Test a single dataset SQL (EXPLAIN validation) | Admin |
| ws-test-all | Test all datasets for a report | Admin |
| ws-save-test-result | Save SQL test result | Admin |
| anthropic-proxy | Claude AI proxy with retry and rate limiting | Admin |
Database Operations
7 endpoints| Action | Description | Auth |
|---|---|---|
| test-pg | TCP connection test to PostgreSQL | Admin |
| test-sql | EXPLAIN validation (plan only, no execution) | Admin |
| run-sql | Execute query with LIMIT 1 for runtime validation | Admin |
| fetch-schemas | Get all table and column schemas | Admin |
| test-mssql | TCP + auth test to SQL Server | Admin |
| run-mssql | Execute SELECT on SQL Server (TOP 100 safety limit) | Admin |
| compare-report-data | Compare query results between SQL Server and PostgreSQL | Admin |
Validation
6 endpoints| Action | Description | Auth |
|---|---|---|
| ws-save-validation | Save validation results (pass/fail per dataset) | Admin |
| ws-get-validations | Get all validation results for a report | Admin |
| ws-approve-validation | Mark a report as validation-approved | Admin |
| ws-clear-validations | Clear all validation results for a report | Admin |
| ws-check-stale | Check if a published report needs re-validation | Admin |
| ws-bulk-approve | Approve validations for multiple reports at once | Admin |
Access Control & Auth
8 endpoints| Action | Description | Auth |
|---|---|---|
| list-orgs | List organizations (tenant-filtered) | Admin |
| create-org | Create organization with full onboarding | Admin |
| list-groups | List Domo groups | Admin |
| list-user-groups | List groups for a specific user | Viewer |
| get-viewer-session | Authenticate viewer, return session config + catalog | Viewer |
| generate-viewer-token | Generate HMAC-signed viewer auth token | Admin |
| get-embed-url | Generate signed report server iframe URL | Viewer |
| sa-invite-user | Full standalone customer onboarding | Admin |
Configuration
6 endpoints| Action | Description | Auth |
|---|---|---|
| get-app-data-v2 | Get config + databases from workspace DB (passwords masked) | Admin |
| write-config-v2 | Write config to workspace DB (optimistic concurrency) | Admin |
| write-database-v2 | Write database connection config | Admin |
| bold-health-check | Health check for the report server | Admin |
| get-global-config | Get cross-organization global config | Admin |
| save-global-config | Save cross-organization global config | Admin |
Public Endpoints
3 endpoints| Action | Description | Auth |
|---|---|---|
| beta-signup | Submit beta application (rate-limited 3/min) | Public |
| beta-submit-feedback | Submit beta user feedback | Public |
| demo-embed-url | Generate signed embed URL for demo reports only | Public |
Rate Limits
anthropic-proxy
10/min
publish-report
30/min
beta-signup
3/min
Default rate limit is 100 requests/min per action. API Gateway enforces global throttling: Admin 50 req/s (burst 100), Viewer 100 req/s (burst 200).