Skip to main content
GET
Report presets

Overview

A report preset stores a Gu1 report template configuration for your organization (name + templateCode + params). After create you can edit name, description, and params; templateCode stays fixed. You can also list, get, run, or delete. Cap: 50 presets per organization. Unique name per org (case-insensitive). Run always queues an async job to object storage (202 + jobId). Download later from Reporting Descargables / Report export jobs. Saved params may include emailLocale, format (csv / pdf / xlsx per template), and other fields (lookbackDays, ruleIds, filters).

Authentication and tenant

string
required
Bearer YOUR_API_KEY β€” see Authentication.
string
required
Production or sandbox organization UUID β€” see Environments.

Permissions

Create

string
required
Display name (1–120 characters). Must be unique within the organization (case-insensitive).
string
Optional note for your team (max 500 characters).
string
required
Code from the Gu1 catalog (for example alerts_by_rules).
object
Template params (lookbackDays, ruleIds, emailLocale, format, filters, etc.). Validated against the template.
On create, Gu1 stores a human-readable paramsSummary (rule names, lookback) for UI. At run time, live params UUIDs are used; missing rules are skipped by the runner.

Example

201 response

Errors

Update

At least one of name, description, or params is required. templateCode cannot change. params are re-validated against the existing template.
string
New name (1–120). Must remain unique in the org.
string
New description (max 500) or null to clear.
object
Full params to persist (replacement, not a partial merge of omitted keys).

Run

Loads the preset and calls the same runner as POST /report-templates/{code}/run with saved params.
string
download (default) or email.
string[]
Required when delivery is email.
string
Optional: csv, xlsx, or pdf (must be supported by the template). If omitted, uses params.format or the template default.
Successful response: 202 (same shape as report-templates run, plus presetId). Always queues a background job. Poll or download via Report export jobs.

Automations

In Reporting, Schedule deep-links to the workflow builder with reportPresetId (canonical). Use automation action send_report / Generar reporte with reportPresetId and optional sendEmail + recipientEmails; legacy reportTemplateCode + params still works.