VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Relatórios e painel

Executar e consultar histórico

Dispara um agendamento na hora e consulta as últimas execuções para saber se o envio funcionou.

Duas rotas para verificar um agendamento sem esperar a próxima rodada: executar na hora e ler o histórico. Ambas exigem o privilégio view_reports.

Executar agora

POST/api/v1/admin/scheduled-reports/{id}/runAdmin

Executa um agendamento imediatamente

Parâmetros de caminho

idintegerobrigatório
Id do agendamento (inteiro).

Exemplo de requisição

Resposta

200Execução concluída

Campos da resposta

okboolean
true quando a execução foi realizada, mesmo que a geração do CSV tenha falhado. Veja o resultado no histórico.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário administrador.{"error":"admin access required"}
403O usuário é administrador, mas não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["view_reports"]}
400id não é um inteiro.{"error":"invalid id"}
500O agendamento não existe.{"error":"failed to run scheduled report","detail":"scheduled report 99999 not found"}
Envia e-mail de verdade

A execução manual faz o mesmo que a automática: gera o CSV, grava no histórico, atualiza last_sent_at e envia o e-mail para os destinatários. Teste primeiro com um endereço seu. A rota não confere is_active: um agendamento pausado também é executado.

Histórico de execuções

GET/api/v1/admin/scheduled-reports/{id}/runsAdmin

Últimas execuções de um agendamento

Parâmetros de caminho

idintegerobrigatório
Id do agendamento (inteiro).

Exemplo de requisição

Resposta

200Execuções

Campos da resposta

runsarray
Até as 20 execuções mais recentes, da mais nova para a mais antiga.
runs[].idinteger
Id da execução.
runs[].scheduled_idinteger
Id do agendamento.
runs[].statusstring
successfailed
Resultado da execução.
runs[].row_countinteger
Linhas de dados do CSV gerado.
runs[].error_messagestring
Motivo da falha. Ausente quando deu certo.
runs[].executed_atstring
Quando rodou, YYYY-MM-DDTHH:MM:SS.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário administrador.{"error":"admin access required"}
403O usuário é administrador, mas não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["view_reports"]}
400id não é um inteiro.{"error":"invalid id"}
Id inexistente

Para um id que não existe a resposta é {"runs":[]} com status 200, igual a um agendamento que ainda não rodou.

Veja também

  • Agendar relatórios
  • Dinheiro, ids e datas
Anterior
Agendar relatórios
Próxima
Análises e relatórios
Nesta página
  • Executar agora
  • Exemplo de requisição
  • Resposta
  • Erros
  • Histórico de execuções
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também
bash
curl -X POST "$BASE_URL/api/v1/admin/scheduled-reports/20/run" \
  -H "Authorization: Bearer $TOKEN"
bash
curl "$BASE_URL/api/v1/admin/scheduled-reports/20/runs" \
  -H "Authorization: Bearer $TOKEN"
json
{
  "ok": true
}
json
{
  "runs": [
    {
      "id": 7,
      "scheduled_id": 20,
      "status": "success",
      "row_count": 7,
      "executed_at": "2026-10-11T21:10:02"
    }
  ]
}