Get dashboard statistics
GET/company/dashboard/
Renvoie des statistiques sur les enchères et les livraisons pour le tableau de bord entreprise de Cargoffer.
Fournit des métriques agrégées sur l'activité opérationnelle et financière des enchères et des livraisons pour le tableau de bord (dashboard) d'une entreprise, permettant l'analyse des performances et le suivi de l'activité sur une plage de dates spécifique.
Objectif
Permettre aux entreprises de visualiser la performance de leurs opérations logistiques grâce à des indicateurs clés de performance (KPI) basés sur les enchères et les livraisons effectuées.
Cas d'utilisation
- Tableau de bord principal : visualisation des KPI de l'année dernière (valeurs par défaut)
- Rapports trimestriels : GET /?minDate=2024-01-01&maxDate=2024-03-31
- Analyse mensuelle : GET /?minDate=2024-05-01&maxDate=2024-05-31
- Analyse annuelle : GET /?minDate=2023-01-01&maxDate=2023-12-31
Métriques des enchères
Pour chaque groupe d'enchères, les données agrégées suivantes sont retournées :
- total_sale : Montant total des ventes calculé selon la logique des offres
- total_auctions : Nombre d'enchères dans le groupe
- total_savings : Économie totale par rapport au prix initial (total_start_price - total_sale)
- sumBidWinner : Somme des montants des offres gagnantes
- total_start_price : Somme des prix initiaux de toutes les enchères
Calcul de total_sale par enchère :
- S'il existe une offre gagnante (bidWinner) : utilise le montant de cette offre
- Sinon, s'il existe une offre assignée (bidAsigned) : utilise le montant de cette offre
- Sinon, si aucune offre n'existe : utilise le prix initial (start_price)
Groupes d'enchères :
- auctions : Toutes les enchères (états : planned, published, awarded,
Request
Responses
- 200
- 401
- 404
- 500
Statistiques récupérées avec succès. Contient les groupes de données suivants :
Groupes d'enchères (AuctionStats) :
- auctions : Toutes les enchères (planifiées, publiées, attribuées, approuvées)
- publishedAuctions : Enchères publiées
- awardedAuctions : Enchères attribuées
- approvedAuctions : Enchères approuvées
- plannedAuctions : Enchères planifiées
Groupes de livraisons (DeliveryStats) :
- plannedDeliveries : Livraisons planifiées
- collectedDeliveries : Livraisons collectées
- deliveredDeliveries : Livraisons effectuées
Chaque groupe d'enchères inclut : total_sale, total_auctions, total_savings, sumBidWinner, total_start_price Chaque groupe de livraisons inclut : total_sale, total_deliveries, sumBidWinner
Response Headers
Non autorisé. Le jeton JWT est invalide, a expiré ou ne dispose pas des autorisations nécessaires pour accéder à ces statistiques.
Solutions :
- Vérifier que le jeton soit valide et n'ait pas expiré
- S'assurer que l'utilisateur possède le rôle d'entreprise
- Demander un nouveau jeton d'authentification
Response Headers
Utilisateur ou entreprise introuvable. Cela se produit lorsque :
- L'ID de l'entreprise associée à l'utilisateur n'existe pas
- L'utilisateur n'a pas d'entreprise assignée
- L'entreprise a été désactivée
Solutions :
- Vérifier que l'utilisateur dispose d'une entreprise valide assignée
- Contacter l'administrateur si l'entreprise apparaît comme désactivée
Response Headers
Erreur interne du serveur