Traffic-Bericht für einen Typ und Zeitraum abrufen¶

Note

Dieser Endpunkt steht nur Organisationen zur Verfügung, für die Traffic-Berichte aktiviert sind, und erfordert Zugriffsrechte auf Admin-Ebene.

Note

SOC-Konten können diesen Endpunkt nicht mit einem persönlichen Zugriffstoken aufrufen. Es gibt kein entsprechendes organisationsbezogenes Token. Nutzen Sie stattdessen den Zugriff über die Webanwendung (Sitzungsauthentifizierung).

Senden einer GET-Anfrage an den Endpunkt /traffic-reports/{type}/{date}.

Beschreibung¶

Mit der Get-Traffic-Report-Anfrage fordern Sie die Einträge des Traffic-Berichts für einen angegebenen Typ und Zeitraum an.

Voraussetzungen¶

Werte der Anfrage: Berichtstyp {type}; Zeitraum {date}

Objekte: keine

Anfrage¶

Um den Traffic-Bericht anzufordern, fügen Sie den Berichtstyp {type} und den Zeitraum {date} dem Pfad der Anfrage hinzu.

Berichtstyp {type} definiert die Granularität des Berichts. Die folgenden Werte stehen zur Verfügung:

Attribut	Beschreibung	Werte
`daily`	Gibt Traffic-Daten aggregiert nach Tag für den angegebenen Monat zurück.
`monthly`	Gibt Traffic-Daten aggregiert nach Monat für den angegebenen Monat zurück.

Zeitraum {date} definiert den Berichtszeitraum. Der Wert muss für die tägliche Granularität YYYY-MM-DD und für die monatliche Granularität YYYY-MM lauten.

Als Ergebnis erhalten Sie ein oder mehrere Objekte TrafficReportVO mit den angefragten Informationen.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`ip`	Die IP-Adresse des Hosts.	`string`
`cidr`	Der CIDR-Block, zu dem die IP-Adresse gehört.	`string`
`period_start`	Der Beginn des Berichtszeitraums in UTC.	`string($date)`
`period_end`	Das Ende des Berichtszeitraums in UTC.	`string($date)`
`traffic`	Der Gesamt-Traffic für den Zeitraum in Bytes.	`number($float)`
`packets`	Die Gesamtzahl der Pakete für den Zeitraum.	`number($float)`

Beispiel¶

Beispiel-Antwort:

{
  "data": [
    {
      "ip": "192.0.2.1",
      "cidr": "192.0.2.0/24",
      "period_start": "2026-04-01",
      "period_end": "2026-04-01",
      "traffic": 1234567,
      "packets": 8910
    }
  ],
  "links": {
    "first": "https://datahub-api.com/api/networks?page=1",
    "last": "https://datahub-api.com/api/networks?page=5",
    "prev": null,
    "next": "https://datahub-api.com/api/networks?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "links": [
      {
        "url": "https://datahub-api.com/api/networks?page=2",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://datahub-api.com/api/networks",
    "per_page": 15,
    "to": 15,
    "total": 64
  }
}

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
200	Die Anfrage war erfolgreich.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.
404	Die Anfrage war nicht erfolgreich, da die angeforderte Ressource nicht gefunden wurde.