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"})Summary
Functions
Consumo: GET /reports/consumption.
Como consumption/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Uso diário: GET /reports/daily-usage.
Como daily_usage/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Dashboard de relatórios: GET /reports/dashboard.
Como dashboard/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Estatísticas do dashboard: GET /dashboard/stats.
Como dashboard_stats/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Análise por device: GET /reports/device-analysis.
Como device_analysis/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Análise de erros: GET /reports/error-analysis.
Como error_analysis/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Extrato: GET /reports/extract.
Como extract/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Gera o relatório de consumo: POST /reports/generate-consumption-report.
Como generate_consumption_report/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Resumo mensal: GET /reports/monthly-summary.
Como monthly_summary/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Estatísticas rápidas: GET /reports/quick-stats.
Como quick_stats/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Requisições recentes: GET /reports/recent-requests.
Como recent_requests/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Resumo: GET /reports/summary.
Como summary/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Types
@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}
Functions
@spec consumption( ApiBrasil.Client.t(), keyword() ) :: result()
Consumo: GET /reports/consumption.
@spec consumption!( ApiBrasil.Client.t(), keyword() ) :: map()
Como consumption/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec daily_usage( ApiBrasil.Client.t(), keyword() ) :: result()
Uso diário: GET /reports/daily-usage.
@spec daily_usage!( ApiBrasil.Client.t(), keyword() ) :: map()
Como daily_usage/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec dashboard( ApiBrasil.Client.t(), keyword() ) :: result()
Dashboard de relatórios: GET /reports/dashboard.
@spec dashboard!( ApiBrasil.Client.t(), keyword() ) :: map()
Como dashboard/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec dashboard_stats( ApiBrasil.Client.t(), keyword() ) :: result()
Estatísticas do dashboard: GET /dashboard/stats.
@spec dashboard_stats!( ApiBrasil.Client.t(), keyword() ) :: map()
Como dashboard_stats/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec device_analysis( ApiBrasil.Client.t(), keyword() ) :: result()
Análise por device: GET /reports/device-analysis.
@spec device_analysis!( ApiBrasil.Client.t(), keyword() ) :: map()
Como device_analysis/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec error_analysis( ApiBrasil.Client.t(), keyword() ) :: result()
Análise de erros: GET /reports/error-analysis.
@spec error_analysis!( ApiBrasil.Client.t(), keyword() ) :: map()
Como error_analysis/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec extract( ApiBrasil.Client.t(), keyword() ) :: result()
Extrato: GET /reports/extract.
@spec extract!( ApiBrasil.Client.t(), keyword() ) :: map()
Como extract/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec generate_consumption_report(ApiBrasil.Client.t(), term(), keyword()) :: result()
Gera o relatório de consumo: POST /reports/generate-consumption-report.
@spec generate_consumption_report!(ApiBrasil.Client.t(), term(), keyword()) :: map()
Como generate_consumption_report/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec monthly_summary( ApiBrasil.Client.t(), keyword() ) :: result()
Resumo mensal: GET /reports/monthly-summary.
@spec monthly_summary!( ApiBrasil.Client.t(), keyword() ) :: map()
Como monthly_summary/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec quick_stats( ApiBrasil.Client.t(), keyword() ) :: result()
Estatísticas rápidas: GET /reports/quick-stats.
@spec quick_stats!( ApiBrasil.Client.t(), keyword() ) :: map()
Como quick_stats/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec recent_requests( ApiBrasil.Client.t(), keyword() ) :: result()
Requisições recentes: GET /reports/recent-requests.
@spec recent_requests!( ApiBrasil.Client.t(), keyword() ) :: map()
Como recent_requests/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec summary( ApiBrasil.Client.t(), keyword() ) :: result()
Resumo: GET /reports/summary.
@spec summary!( ApiBrasil.Client.t(), keyword() ) :: map()
Como summary/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.