Get dashboard statistics
GET/company/dashboard/
Gibt Auktions- und Lieferstatistiken für das Unternehmens-Dashboard von Cargoffer zurück.
Liefert aggregierte Metriken zur operativen und finanziellen Aktivität von Auktionen und Lieferungen für das Dashboard eines Unternehmens, um Leistungsanalysen und Aktivitätsverfolgung innerhalb eines spezifischen Datumsbereichs zu ermöglichen.
Ziel
Unternehmen sollen die Leistung ihrer logistischen Operationen anhand wichtiger Leistungskennzahlen (KPIs) basierend auf durchgeführten Auktionen und Lieferungen visualisieren können.
Anwendungsfälle
- Haupt-Dashboard: Visualisierung der KPIs des letzten Jahres (Standardwerte)
- Quartalsberichte: GET /?minDate=2024-01-01&maxDate=2024-03-31
- Monatsanalyse: GET /?minDate=2024-05-01&maxDate=2024-05-31
- Jahresanalyse: GET /?minDate=2023-01-01&maxDate=2023-12-31
Auktionsmetriken
Für jede Auktionsgruppe werden folgende aggregierte Daten zurückgegeben:
- total_sale: Gesamtumsatz, berechnet gemäß der Gebotslogik
- total_auctions: Anzahl der Auktionen in der Gruppe
- total_savings: Gesamtersparnis gegenüber dem Startpreis (total_start_price - total_sale)
- sumBidWinner: Summe der Beträge der gewinnenden Gebote
- total_start_price: Summe der Startpreise aller Auktionen
Berechnung von total_sale pro Auktion:
- Falls ein gewinnendes Gebot (bidWinner) existiert: verwende den Betrag dieses Gebots
- Falls nicht, aber ein zugewiesenes Gebot (bidAsigned) existiert: verwende den Betrag dieses Gebots
- Falls kein Gebot vorhanden ist: verwende den Startpreis (start_price)
Auktionsgruppen:
- auctions: Alle Auktionen (Status: planned, published, awarded, approved)
- publishedAuctions: Veröffentlichte Auk
Request
Responses
- 200
- 401
- 404
- 500
Statistiken erfolgreich abgerufen. Enthält die folgenden Datengruppen:
Auktionsgruppen (AuctionStats):
- auctions: Alle Auktionen (geplant, veröffentlicht, vergeben, genehmigt)
- publishedAuctions: Veröffentlichte Auktionen
- awardedAuctions: Vergebene Auktionen
- approvedAuctions: Genehmigte Auktionen
- plannedAuctions: Geplante Auktionen
Liefergruppen (DeliveryStats):
- plannedDeliveries: Geplante Lieferungen
- collectedDeliveries: Abgeholte Lieferungen
- deliveredDeliveries: Abgeschlossene Lieferungen
Jede Auktionsgruppe enthält: total_sale, total_auctions, total_savings, sumBidWinner, total_start_price Jede Liefergruppe enthält: total_sale, total_deliveries, sumBidWinner
Response Headers
Nicht autorisiert. Das JWT-Token ist ungültig, abgelaufen oder hat keine Berechtigung zum Zugriff auf diese Statistiken.
Lösungen:
- Überprüfen, ob das Token gültig und nicht abgelaufen ist
- Sicherstellen, dass der Benutzer die Rolle 'Unternehmen' hat
- Einen neuen Authentifizierungstoken anfordern
Response Headers
Benutzer oder Unternehmen nicht gefunden. Tritt auf, wenn:
- Die mit dem Benutzer verknüpfte Unternehmens-ID nicht existiert
- Dem Benutzer kein Unternehmen zugewiesen ist
- Das Unternehmen deaktiviert wurde
Lösungen:
- Überprüfen, ob dem Benutzer ein gültiges Unternehmen zugewiesen ist
- Kontaktieren Sie den Administrator, wenn das Unternehmen als deaktiviert angezeigt wird
Response Headers
Interner Serverfehler