The reports system allows users to save filter configurations as presets, create reusable templates, and generate public share links for reports.
Report presets Presets store named filter and state snapshots for a specific report. They are scoped to the tenant and associated with the user who created them.
List presets Returns all presets for the authenticated user’s active tenant, filtered by report key.
Query parameters Identifier for the report type (e.g. obras, certificados).
Response Array of preset objects ordered by updated_at descending. Show ReportPreset properties
UUID of the user who created the preset.
Saved filter configuration.
curl 'https://<domain>/api/reports/presets?reportKey=obras' \ --cookie 'sb-access-token=<session>'
{ "presets" : [ { "id" : "preset-uuid-..." , "tenant_id" : "tenant-uuid-..." , "owner_user_id" : "user-uuid-..." , "report_key" : "obras" , "name" : "Obras en curso — MUNICIPIO" , "filters" : { "status" : "in-process" , "entidad" : [ "MUNICIPIO" ] }, "report_state" : { "columns" : [ "n" , "designacion" , "porcentaje" ] }, "updated_at" : "2024-06-01T12:00:00Z" } ] }
Create a preset POST /api/reports/presets
Creates a new saved preset for the authenticated user.
Request body Display name for the preset.
Filter configuration to save. Defaults to {}.
Report UI state to save. Defaults to {}.
Response The newly created preset.
curl -X POST 'https://<domain>/api/reports/presets' \ --cookie 'sb-access-token=<session>' \ --header 'Content-Type: application/json' \ --data '{ "reportKey": "obras", "name": "Obras en curso — MUNICIPIO", "filters": { "status": "in-process", "entidad": ["MUNICIPIO"] }, "reportState": {} }'
{ "preset" : { "id" : "preset-uuid-..." , "report_key" : "obras" , "name" : "Obras en curso — MUNICIPIO" , "filters" : { "status" : "in-process" , "entidad" : [ "MUNICIPIO" ] }, "report_state" : {} } }
Delete a preset DELETE /api/reports/presets
Deletes a preset by ID. The preset must belong to the authenticated user’s active tenant.
Query parameters UUID of the preset to delete.
Response Report templates Templates are reusable report configurations. Unlike presets (which are personal), templates belong to the tenant.
List templates GET /api/reports/templates
Returns all templates for the authenticated user’s active tenant, filtered by report key.
Query parameters Response Array of template objects ordered by updated_at descending. Show ReportTemplate properties
Template configuration payload.
Whether this is a system-managed template.
Create a template POST /api/reports/templates
Creates a new report template for the tenant.
Request body Template configuration. Defaults to {}.
Mark as a system template. Defaults to false.
Response The newly created template.
Delete a template DELETE /api/reports/templates
Deletes a template by ID.
Query parameters UUID of the template to delete.
Response Share links Share links let authenticated users create token-based public URLs for a specific report state. The token can be used without authentication to retrieve the report payload.
Create a share link Creates a share link for a report. Returns the share record and the relative URL path (/r/{token}).
Request body The report state/data to embed in the share link.
Optional UUID of an associated preset.
Optional ISO 8601 expiry timestamp. If omitted the link never expires.
Response The full share link record from the database.
Relative URL path for the share link, e.g. /r/abc123.
curl -X POST 'https://<domain>/api/reports/share' \ --cookie 'sb-access-token=<session>' \ --header 'Content-Type: application/json' \ --data '{ "reportKey": "obras", "payload": { "filters": { "status": "completed" } }, "expiresAt": "2025-12-31T23:59:59Z" }'
{ "share" : { "id" : "share-uuid-..." , "tenant_id" : "tenant-uuid-..." , "report_key" : "obras" , "token" : "abc123def456" , "payload" : { "filters" : { "status" : "completed" } }, "expires_at" : "2025-12-31T23:59:59Z" , "created_by" : "user-uuid-..." }, "url" : "/r/abc123def456" }
Resolve a share link Resolves a share link by token. This endpoint does not require authentication — it is intended for public consumers of shared reports.
If the share link has an expires_at in the past, the endpoint returns 410 Gone.
Query parameters The share token (from the url returned when the link was created).
Response The full share link record, including the embedded payload.
curl 'https://<domain>/api/reports/share?token=abc123def456'
{ "share" : { "id" : "share-uuid-..." , "report_key" : "obras" , "token" : "abc123def456" , "payload" : { "filters" : { "status" : "completed" } }, "expires_at" : "2025-12-31T23:59:59Z" } }
