API: Sonstige Endpunkte

GET /dashboard

Ruft Dashboard-Daten ab: Auftragsstatus-Übersicht, Umsätze der letzten 30 Tage und Buybox-Auswertung. Die Verfügbarkeit einzelner Bereiche hängt von den Berechtigungen des API-Benutzers ab.

URL: GET /public_api/<token>/dashboard

Request-Parameter

Keine.

Beispiel-Request

curl -X GET "https://meinefirma.scanalot.io/public_api/<token>/dashboard" \
  -H "Authorization: <api-token>"

Erfolgreiche Antwort

{
  "status": {
    "valid": true,
    "data": [
      {
        "id": 1,
        "name": "Offen",
        "color": "#ff9800",
        "position": 1
      },
      {
        "id": 2,
        "name": "In Bearbeitung",
        "color": "#2196f3",
        "position": 2
      }
    ]
  },
  "statusData": [
    {
      "statusId": 1,
      "orders": 42
    },
    {
      "statusId": 2,
      "orders": 15
    }
  ],
  "salesData": {
    "valid": true,
    "error": null,
    "labels": ["16.02.2024", "17.02.2024", "..."],
    "datasets": [
      {
        "label": "Hauptmandant (EUR)",
        "data": [1250.50, 980.00, "..."],
        "borderWidth": 1
      }
    ]
  },
  "buyboxData": {
    "valid": true,
    "error": null,
    "labels": ["amazon.de (85.50%)", "amazon.fr (72.30%)"],
    "datasets": [
      {
        "label": "Buybox Ja",
        "data": [171, 94],
        "backgroundColor": "rgba(75, 192, 192, 0.6)",
        "borderColor": "rgba(75, 192, 192, 1)",
        "borderWidth": 1
      },
      {
        "label": "Buybox Nein",
        "data": [29, 36],
        "backgroundColor": "rgba(255, 99, 132, 0.6)",
        "borderColor": "rgba(255, 99, 132, 1)",
        "borderWidth": 1
      }
    ]
  }
}

Antwort-Felder

status

Die konfigurierten Auftrags-Status.

Feld	Typ	Beschreibung
`status.valid`	Boolean	Ob Status-Daten verfügbar sind
`status.data[].id`	Integer	Status-ID
`status.data[].name`	String	Status-Bezeichnung
`status.data[].color`	String	Farbe als Hex-Code
`status.data[].position`	Integer	Sortierposition

statusData

Anzahl der Aufträge pro Status.

Feld	Typ	Beschreibung
`statusData[].statusId`	Integer	Status-ID
`statusData[].orders`	Integer	Anzahl der Aufträge in diesem Status

salesData

Umsätze der letzten 30 Tage, gruppiert nach Mandant und Währung.

Feld	Typ	Beschreibung
`salesData.valid`	Boolean	`true` wenn der Benutzer die Berechtigung `dashboard.sales_30_days.get` hat
`salesData.error`	String/null	Fehlermeldung bei fehlender Berechtigung
`salesData.labels`	Array	Datumswerte im Format `DD.MM.YYYY` (30 Tage)
`salesData.datasets[].label`	String	Bezeichnung: `"Mandantenname (Währung)"`
`salesData.datasets[].data`	Array	Umsatzwerte pro Tag (Brutto)
`salesData.datasets[].borderWidth`	Integer	Linienbreite für Diagramme

buyboxData

Amazon Buybox-Auswertung pro Marketplace.

Feld	Typ	Beschreibung
`buyboxData.valid`	Boolean	`true` wenn der Benutzer die Berechtigung `dashboard.buybox_share.get` hat
`buyboxData.error`	String/null	Fehlermeldung bei fehlender Berechtigung
`buyboxData.labels`	Array	Marketplace-Bezeichnungen mit Buybox-Prozentsatz
`buyboxData.datasets[0].label`	String	`"Buybox Ja"`
`buyboxData.datasets[0].data`	Array	Anzahl Listings mit Buybox pro Marketplace
`buyboxData.datasets[1].label`	String	`"Buybox Nein"`
`buyboxData.datasets[1].data`	Array	Anzahl Listings ohne Buybox pro Marketplace