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

bash

curl -X POST "$BASE_URL/api/v1/admin/scheduled-reports/20/run" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Execução concluída

json

{
  "ok": true
}

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

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

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

bash

curl "$BASE_URL/api/v1/admin/scheduled-reports/20/runs" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Execuções

json

{
  "runs": [
    {
      "id": 7,
      "scheduled_id": 20,
      "status": "success",
      "row_count": 7,
      "executed_at": "2026-10-11T21:10:02"
    }
  ]
}

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

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

Veja também

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

bash

curl -X POST "$BASE_URL/api/v1/admin/scheduled-reports/20/run" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Execução concluída

json

{
  "ok": true
}

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

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

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

bash

curl "$BASE_URL/api/v1/admin/scheduled-reports/20/runs" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Execuções

json

{
  "runs": [
    {
      "id": 7,
      "scheduled_id": 20,
      "status": "success",
      "row_count": 7,
      "executed_at": "2026-10-11T21:10:02"
    }
  ]
}

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

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