Skip to main content
GET
Report templates

Overview

Gu1 publishes a code-first catalog of operational templates (alerts by rules, bulk exports, and Metrics Hub views). The same templates power Reporting (on demand) and the automation action send_report / Generar reporte (reportPresetId or reportTemplateCode + params). All operational runs (including alerts_by_rules) enqueue a background job, store the file in object storage, and return 202 with result.jobId. Download later from Report export jobs (Reporting Descargables). They share the org export cooldown when applicable.

Authentication and tenant

string
required
Bearer YOUR_API_KEY — see Authentication.
string
required
Production or sandbox organization UUID — see Environments.

Permissions

List templates

string
Optional filter: alerts, metrics, entities, transactions, investigations.

Get a template

Returns 404 with REPORT_TEMPLATE_NOT_FOUND if the code does not exist.

Preview (sample data)

Returns a CSV or PDF file with demo rows (does not query tenant data).
string
csv (default) or pdf.
string
Optional: es, en, or pt (PDF copy).
Response: binary with Content-Disposition: attachment (preview-{code}.csv|pdf).

Run a template

object
Template parameters (lookbackDays, ruleIds, emailLocale, filters, etc.).
string
Must be in the template formats. Default: defaultFormat.
string
required
download (queue job only) or email (queue job + send mail). Reporting UI always uses download.
string[]
Required when delivery is email.

Response (202)

Semantics: alerts_by_rules

Exports already-created alerts for the tenant whose alerted_at falls in the lookbackDays window.
  • ruleIds (UUID array, optional): when set, filters trigger_rule_id IN (...). Empty = all rules.
  • Columns: entity, tax ID, alert, severity, status, score, rule, investigation number, case/alert link, date.
  • Order: entity name, then alert date.
  • Does not re-run the matrix or invent thresholds: only lists persisted alerts.

Rate limit

If another org export ran recently, the API may return 429 with EXPORT_RATE_LIMIT, Retry-After, and retryAfterSeconds / cooldownSeconds in error.details.

Example

202 response (email)

202 response (download)

Automations

Scheduled delivery uses send_report (Generar reporte) with either:
  • reportPresetId (canonical): runs the frozen preset; always creates an S3 job. Set sendEmail: true plus recipientEmails to also email the file.
  • Legacy: reportTemplateCode + params, or reportType without a preset.
Deep-link from Reporting Programar: /automations/builder?type=scheduled&reportPresetId=…. See Report export jobs for Descargables.

Configurable filters

Operational templates expose a field → operator → value builder. Send conditions in params.filters; every condition is combined with AND. An empty list includes all records. Saved report presets freeze the complete conditions. Catalog-backed fields change their control according to the operator: equals receives one value and in receives an array. For example, country accepts { "operator": "equals", "value": "AR" } or { "operator": "in", "value": ["AR", "BR"] }.
  • Alerts: rule (in), severity, status, affected type, score, false-positive flag, alert date and alert type.
  • Entities: type, status, exact Tax ID or custom-list membership, country, external ID, search, age, score, KYC status, matched rule, creation/enrichment dates, PEP, sanctions, adverse media, MEI, legal proceedings —including criminal proceedings—, shareholders, relationships, electoral activity, economic activities and active investigations.
  • Transactions: type, status, payment method, score, amount, currency, date, matched rule, related Tax ID, origin/destination external IDs, self-transactions, missing risk evaluation, shadow-rule hits, search, flagged state and alert presence.
  • Investigations: status, priority, typology, score, target type, creation/update dates and title/description search.
Available operators depend on the field: equals, contains, in, gte, lte, between, before, after, is_true, is_false, in_custom_list, and not_in_custom_list. The catalog returned by GET /report-templates includes filterFields with each template’s valid operators and options.