Packages

SDK oficial Elixir da plataforma APIBrasil: WhatsApp, SMS, consultas de CPF/CNPJ, veiculos, CEP, correios, pagamentos PIX/boleto e mais.

Current section

Files

Jump to
apibrasil lib api_brasil platform reports.ex
Raw

lib/api_brasil/platform/reports.ex

defmodule ApiBrasil.Platform.Reports do
@moduledoc """
Relatórios e dashboard de consumo (`/reports/*`, `/dashboard/stats`).
alias ApiBrasil.Platform.Reports
{:ok, stats} = Reports.dashboard_stats(client)
{:ok, consumo} = Reports.consumption(client, query: %{"from" => "2024-01-01"})
"""
use ApiBrasil.Core.Service
route_get(
:dashboard_stats,
"dashboard/stats",
"Estatísticas do dashboard: `GET /dashboard/stats`."
)
route_get(:consumption, "reports/consumption", "Consumo: `GET /reports/consumption`.")
route_get(:extract, "reports/extract", "Extrato: `GET /reports/extract`.")
route_get(:dashboard, "reports/dashboard", "Dashboard de relatórios: `GET /reports/dashboard`.")
route_get(:summary, "reports/summary", "Resumo: `GET /reports/summary`.")
route_get(:daily_usage, "reports/daily-usage", "Uso diário: `GET /reports/daily-usage`.")
route_get(
:monthly_summary,
"reports/monthly-summary",
"Resumo mensal: `GET /reports/monthly-summary`."
)
route_get(
:error_analysis,
"reports/error-analysis",
"Análise de erros: `GET /reports/error-analysis`."
)
route_get(
:device_analysis,
"reports/device-analysis",
"Análise por device: `GET /reports/device-analysis`."
)
route_get(
:recent_requests,
"reports/recent-requests",
"Requisições recentes: `GET /reports/recent-requests`."
)
route_get(
:quick_stats,
"reports/quick-stats",
"Estatísticas rápidas: `GET /reports/quick-stats`."
)
route_post(
:generate_consumption_report,
"reports/generate-consumption-report",
"Gera o relatório de consumo: `POST /reports/generate-consumption-report`."
)
end