Skip to main content
GET
Presets de reportes

Overview

Un preset de reporte guarda una configuración de plantilla de reportes Gu1 para tu organización (name + templateCode + params). Tras crearlo podés editar name, description y params; el templateCode queda fijo. También podés listar, obtener, ejecutar o eliminar. Límite: 50 presets por organización. Nombre único por org (sin distinguir mayúsculas). Ejecutar siempre encola un job async a object storage (202 + jobId). Descargá después desde Reportería Descargables / Jobs de exportación de reportes. Los params pueden incluir emailLocale, format (csv / pdf / xlsx según plantilla) y otros campos (lookbackDays, ruleIds, filters).

Autenticación y tenant

string
required
Bearer YOUR_API_KEY — ver Autenticación.
string
required
UUID de organización producción o sandbox — ver Entornos.

Permisos

Crear

string
required
Nombre visible (1–120 caracteres). Debe ser único en la organización (sin distinguir mayúsculas).
string
Nota opcional para tu equipo (máx. 500 caracteres).
string
required
Código del catálogo Gu1 (por ejemplo alerts_by_rules).
object
Params de la plantilla (lookbackDays, ruleIds, emailLocale, format, filters, etc.). Validados contra la plantilla.
Al crear, Gu1 guarda un paramsSummary legible (nombres de reglas, ventana) para la UI. Al ejecutar, se usan los UUID vivos de params; reglas inexistentes las omite el runner.

Ejemplo

Respuesta 201

Errores

Actualizar

Al menos uno de name, description o params es obligatorio. No se puede cambiar templateCode. Los params se revalidan contra la plantilla existente.
string
Nuevo nombre (1–120). Debe seguir siendo único en la org.
string
Nueva descripción (máx. 500) o null para limpiar.
object
Params completos a persistir (reemplazo, no merge parcial de claves omitidas).

Ejecutar

Carga el preset y llama al mismo runner que POST /report-templates/{code}/run con los params guardados.
string
download (default) o email.
string[]
Obligatorio cuando delivery es email.
string
Opcional: csv, xlsx o pdf (debe estar soportado por la plantilla). Si se omite, usa params.format o el default de la plantilla.
Respuesta exitosa: 202 (mismo shape que run de plantillas, más presetId). Siempre encola un job en segundo plano. Consultá o descargá vía Jobs de exportación de reportes.

Automatizaciones

En Reportería, Programar abre el builder con reportPresetId (canónico). Usá la acción send_report / Generar reporte con reportPresetId y opcionalmente sendEmail + recipientEmails; el legacy reportTemplateCode + params sigue funcionando.