Skip to main content
GET
Presets de relatórios

Overview

Um preset de relatório guarda uma configuração de modelo de relatório Gu1 para sua organização (name + templateCode + params). Após criar, você pode editar name, description e params; o templateCode fica fixo. Também pode listar, obter, executar ou excluir. Limite: 50 presets por organização. Nome único por org (sem distinguir maiúsculas). Executar sempre enfileira um job async para object storage (202 + jobId). Baixe depois em Relatórios Downloads / Jobs de exportação de relatórios. Os params podem incluir emailLocale, format (csv / pdf / xlsx conforme o modelo) e outros campos (lookbackDays, ruleIds, filters).

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

Criar

string
required
Nome visível (1–120 caracteres). Deve ser único na organização (sem distinguir maiúsculas).
string
Nota opcional para sua equipe (máx. 500 caracteres).
string
required
Código do catálogo Gu1 (por exemplo alerts_by_rules).
object
Params do modelo (lookbackDays, ruleIds, emailLocale, format, filters, etc.). Validados contra o modelo.
Ao criar, a Gu1 guarda um paramsSummary legível (nomes de regras, janela) para a UI. Ao executar, usam-se os UUIDs vivos de params; regras inexistentes são omitidas pelo runner.

Exemplo

Resposta 201

Erros

Atualizar

Pelo menos um de name, description ou params é obrigatório. Não é possível alterar templateCode. Os params são revalidados contra o modelo existente.
string
Novo nome (1–120). Deve continuar único na org.
string
Nova descrição (máx. 500) ou null para limpar.
object
Params completos a persistir (substituição, não merge parcial de chaves omitidas).

Executar

Carrega o preset e chama o mesmo runner que POST /report-templates/{code}/run com os params salvos.
string
download (default) ou email.
string[]
Obrigatório quando delivery é email.
string
Opcional: csv, xlsx ou pdf (deve ser suportado pelo modelo). Se omitido, usa params.format ou o default do modelo.
Resposta de sucesso: 202 (mesmo shape que run de modelos, mais presetId). Sempre enfileira um job em segundo plano. Consulte ou baixe via Jobs de exportação de relatórios.

Automações

Em Relatórios, Agendar abre o builder com reportPresetId (canônico). Use a ação send_report / Gerar relatório com reportPresetId e opcionalmente sendEmail + recipientEmails; o legado reportTemplateCode + params continua funcionando.