Skip to main content
GET
Modelos de relatórios

Resumo

A Gu1 publica um catálogo code-first de modelos operacionais (alertas por regras, exportações em massa e vistas do Metrics Hub). Os mesmos modelos alimentam Relatórios (sob demanda) e a ação de automation send_report / Gerar relatório (reportPresetId ou reportTemplateCode + params). Todas as execuções operacionais (incluindo alerts_by_rules) enfileiram um job em segundo plano, gravam o arquivo em object storage e respondem 202 com result.jobId. Baixe depois em Jobs de exportação de relatórios (Relatórios Downloads). Compartilham o cooldown de export por organização quando aplicável.

Autenticação e tenant

string
required
Bearer YOUR_API_KEY — ver Autenticação.
string
required
UUID da organização produção ou sandbox — ver Ambientes.

Permissões

Listar modelos

string
Filtro opcional: alerts, metrics, entities, transactions, investigations.

Obter um modelo

Retorna 404 com REPORT_TEMPLATE_NOT_FOUND se o código não existir.

Pré-visualização (dados de exemplo)

Retorna um arquivo CSV ou PDF com linhas de demonstração (não consulta dados do tenant).
string
csv (default) ou pdf.
string
Opcional: es, en ou pt (copy do PDF).
Resposta: binário com Content-Disposition: attachment (preview-{code}.csv|pdf).

Executar um modelo

object
Parâmetros do modelo (lookbackDays, ruleIds, emailLocale, filters, etc.).
string
Deve estar em formats do modelo. Default: defaultFormat.
string
required
download (apenas enfileirar job) ou email (enfileirar job + enviar e-mail). A UI de Relatórios sempre usa download.
string[]
Obrigatório se delivery for email.

Resposta (202)

Semântica: alerts_by_rules

Exporta alertas já criadas do tenant cujo alerted_at cai na janela lookbackDays.
  • ruleIds (array UUID, opcional): se enviado, filtra trigger_rule_id IN (...). Vazio = todas as regras.
  • Colunas: entidade, tax ID, alerta, severidade, status, score, regra, nº da investigação, link do caso/alerta, data.
  • Ordem: nome da entidade, depois data da alerta.
  • Não recalcula a matriz nem inventa limiares: apenas lista alertas persistidas.

Rate limit

Se houve outra exportação recente na org, pode responder 429 com EXPORT_RATE_LIMIT, header Retry-After e retryAfterSeconds / cooldownSeconds em error.details.

Exemplo

Resposta 202 (email)

Resposta 202 (download)

Automations

A entrega agendada usa send_report (Gerar relatório) com:
  • reportPresetId (canônico): executa o preset congelado; sempre cria um job no S3. Com sendEmail: true e recipientEmails também envia o arquivo por e-mail.
  • Legacy: reportTemplateCode + params, ou reportType sem preset.
Deep-link a partir de Relatórios Agendar: /automations/builder?type=scheduled&reportPresetId=…. Ver Jobs de exportação de relatórios para Downloads.

Filtros configuráveis

Os templates operacionais oferecem um construtor campo → operador → valor. Envie as condições em params.filters; todas são combinadas com E. Uma lista vazia inclui todos os registros. Os presets de relatórios congelam as condições completas. Os campos com catálogo alteram o controle conforme o operador: equals recebe um valor e in recebe um array. Por exemplo, país aceita { "operator": "equals", "value": "AR" } ou { "operator": "in", "value": ["AR", "BR"] }.
  • Alertas: regra (in), severidade, status, tipo afetado, score, falso positivo, data e tipo do alerta.
  • Entidades: tipo, status, Tax ID exato ou em lista personalizada, país, ID externo, busca, idade, score, status KYC, regra com hit, datas de criação/enriquecimento, PEP, sanções, mídia adversa, MEI, processos legais —incluindo criminais—, sócios, relações, atividade eleitoral, atividades econômicas e investigações ativas.
  • Transações: tipo, status, meio de pagamento, score, valor, moeda, data, regra com hit, Tax ID relacionado, IDs externos de origem/destino, autotransação, ausência de avaliação, hit de regra shadow, busca, marcada e presença de alertas.
  • Investigações: status, prioridade, tipologia, score, tipo de alvo, datas de criação/atualização e busca em título/descrição.
Os operadores disponíveis dependem do campo: equals, contains, in, gte, lte, between, before, after, is_true, is_false, in_custom_list e not_in_custom_list. O catálogo retornado por GET /report-templates inclui filterFields com os operadores e opções válidos de cada template.