Pular para o conteúdo principal

Get dashboard statistics

GET 
/company/dashboard/

Retorna estatísticas de leilões e entregas para o painel de controle empresarial do Cargoffer.

Fornece métricas agregadas de atividade operacional e financeira de leilões e entregas para o painel de controle (dashboard) de uma empresa, permitindo análise de desempenho e acompanhamento de atividade em um intervalo de datas específico.

Objetivo​

Permitir que as empresas visualizem o desempenho de suas operações logísticas por meio de indicadores-chave de desempenho (KPIs) baseados em leilões e entregas realizadas.

Casos de uso​

  • Dashboard principal: visualização de KPIs do último ano (valores padrão)
  • Relatórios trimestrais: GET /?minDate=2024-01-01&maxDate=2024-03-31
  • Análise mensal: GET /?minDate=2024-05-01&maxDate=2024-05-31
  • Análise anual: GET /?minDate=2023-01-01&maxDate=2023-12-31

Métricas de leilões​

Para cada grupo de leilões são retornados os seguintes dados agregados:

  • total_sale: Valor total de vendas calculado de acordo com a lógica de lances
  • total_auctions: Quantidade de leilões no grupo
  • total_savings: Economia total vs preço inicial (total_start_price - total_sale)
  • sumBidWinner: Soma dos valores dos lances vencedores
  • total_start_price: Soma dos preços iniciais de todos os leilões

Cálculo de total_sale por leilão:

  1. Se existir lance vencedor (bidWinner): usa o valor desse lance
  2. Se não, mas existir lance atribuído (bidAsigned): usa o valor desse lance
  3. Se não tiver nenhum lance: usa o preço inicial (start_price)

Grupos de leilões:

  • auctions: Todos os leilões (estados: planned, published, awarded, approved)
  • publishedAuctions: Leilões publicados (status: published)
  • **awardedAu

Request​

Responses​

Estatísticas recuperadas com sucesso. Contém os seguintes grupos de dados:

Grupos de leilões (AuctionStats):

  • auctions: Todos os leilões (planejados, publicados, adjudicados, aprovados)
  • publishedAuctions: Leilões publicados
  • awardedAuctions: Leilões adjudicados
  • approvedAuctions: Leilões aprovados
  • plannedAuctions: Leilões planejados

Grupos de entregas (DeliveryStats):

  • plannedDeliveries: Entregas planejadas
  • collectedDeliveries: Entregas recolhidas
  • deliveredDeliveries: Entregas concluídas

Cada grupo de leilões inclui: total_sale, total_auctions, total_savings, sumBidWinner, total_start_price Cada grupo de entregas inclui: total_sale, total_deliveries, sumBidWinner

Response Headers