API docs by Redocly

FastAPI (0.1.0)

Download OpenAPI specification:Download

Retrieve traffic summary by domain

Retrieves a summary of network traffic grouped by domain name. Each entry includes:

  • Address: The domain name accessed.
  • Sent: Total bytes sent to this domain.
  • Received: Total bytes received from this domain.

Query Parameters:

  • start_date, start_time, end_date, end_time: Absolute time filters.
  • relative: Relative time range (e.g., 60s, 30m, 1h).
  • timezone: Timezone for timestamps.
  • client: Filter by a specific local IP.
query Parameters
Start Date (string) or Start Date (null) (Start Date)
Start Time (string) or Start Time (null) (Start Time)
End Date (string) or End Date (null) (End Date)
End Time (string) or End Time (null) (End Time)
Relative (string) or Relative (null) (Relative)
Timezone (string) or Timezone (null) (Timezone)
Client (string) or Client (null) (Client)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve traffic summary by remote IP

Retrieves a summary of network traffic grouped by remote IP address. Each entry includes:

  • Address: The remote IP address accessed.
  • Sent: Total bytes sent to this IP.
  • Received: Total bytes received from this IP.

Query Parameters:

  • start_date, start_time, end_date, end_time: Absolute time filters.
  • relative: Relative time range (e.g., 60s, 30m, 1h).
  • timezone: Timezone for timestamps.
  • client: Filter by a specific local IP.
query Parameters
Start Date (string) or Start Date (null) (Start Date)
Start Time (string) or Start Time (null) (Start Time)
End Date (string) or End Date (null) (End Date)
End Time (string) or End Time (null) (End Time)
Relative (string) or Relative (null) (Relative)
Timezone (string) or Timezone (null) (Timezone)
Client (string) or Client (null) (Client)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve traffic summary by local IP

Retrieves a summary of network traffic grouped by local IP addresses.

Query Parameters:

  • start_date, start_time, end_date, end_time: Absolute time filters.
  • relative: Relative time range (e.g., 60s, 30m, 1h).
  • timezone: Timezone for timestamps.
  • client: Filter by a specific local IP.
query Parameters
Start Date (string) or Start Date (null) (Start Date)
Start Time (string) or Start Time (null) (Start Time)
End Date (string) or End Date (null) (End Date)
End Time (string) or End Time (null) (End Time)
Relative (string) or Relative (null) (Relative)
Timezone (string) or Timezone (null) (Timezone)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve total network traffic

Retrieves the total amount of network traffic sent and received.

Response:

{
  "sent": 1048576,
  "received": 2097152
}

Query Parameters:

  • start_date, start_time, end_date, end_time: Absolute time filters.
  • relative: Relative time range (e.g., 60s, 30m, 1h).
  • timezone: Timezone for timestamps.
  • client: Filter by a specific local IP.
query Parameters
Start Date (string) or Start Date (null) (Start Date)
Start Time (string) or Start Time (null) (Start Time)
End Date (string) or End Date (null) (End Date)
End Time (string) or End Time (null) (End Time)
Relative (string) or Relative (null) (Relative)
Timezone (string) or Timezone (null) (Timezone)
Client (string) or Client (null) (Client)

Responses

Response samples

Content type
application/json
{
  • "sent": 0,
  • "received": 0
}

Retrieve sorted traffic summary by domain or IP

Retrieves a sorted summary of network traffic grouped by domain name (if available) or remote IP address. Each entry includes:

  • Address: The domain name if known, otherwise the remote IP (optionally with port).
  • Sent: Total bytes sent to this address.
  • Received: Total bytes received from this address.
  • Count: The number of times this address was accessed.

Results are ordered by highest access count.

Query Parameters:

  • start_date: Start date filter (YYYY-MM-DD).
  • start_time: Start time filter (HH:MM:SS).
  • end_date: End date filter (YYYY-MM-DD).
  • end_time: End time filter (HH:MM:SS).
  • relative: Relative time range (e.g., 60s, 30m, 1h).
  • timezone: Timezone for timestamps (e.g., UTC, America/New_York).
  • client: Filter by a specific local IP.

Example Response:

[
  {
    "address": "example.com:443",
    "sent": 12345,
    "received": 67890,
    "count": 42
  },
  {
    "address": "192.168.1.100:80",
    "sent": 5120,
    "received": 10240,
    "count": 18
  }
]
query Parameters
Start Date (string) or Start Date (null) (Start Date)
Start Time (string) or Start Time (null) (Start Time)
End Date (string) or End Date (null) (End Date)
End Time (string) or End Time (null) (End Time)
Relative (string) or Relative (null) (Relative)
Timezone (string) or Timezone (null) (Timezone)
Client (string) or Client (null) (Client)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve traffic summary by remote address with port

Retrieves a summary of network traffic grouped by remote domain or IP, including port information.

Query Parameters:

  • start_date, start_time, end_date, end_time: Absolute time filters.
  • relative: Relative time range (e.g., 60s, 30m, 1h).
  • timezone: Timezone for timestamps.
  • client: Filter by a specific local IP.
query Parameters
Start Date (string) or Start Date (null) (Start Date)
Start Time (string) or Start Time (null) (Start Time)
End Date (string) or End Date (null) (End Date)
End Time (string) or End Time (null) (End Time)
Relative (string) or Relative (null) (Relative)
Timezone (string) or Timezone (null) (Timezone)
Client (string) or Client (null) (Client)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve raw network traffic logs

Retrieves raw network traffic logs, including timestamps and data transferred.

Query Parameters:

  • start_date, start_time, end_date, end_time: Absolute time filters.
  • relative: Relative time range (e.g., 60s, 30m, 1h).
  • timezone: Timezone for timestamps.
  • client: Filter by a specific local IP.

Example Response:

[
  {
    "timestamp": "2024-10-13 12:34:56",
    "local": "192.168.1.10",
    "remote": "93.184.216.34",
    "port": 443,
    "sent": 1500,
    "received": 3000,
    "domain": "example.com"
  }
]
query Parameters
Start Date (string) or Start Date (null) (Start Date)
Start Time (string) or Start Time (null) (Start Time)
End Date (string) or End Date (null) (End Date)
End Time (string) or End Time (null) (End Time)
Relative (string) or Relative (null) (Relative)
Timezone (string) or Timezone (null) (Timezone)
Client (string) or Client (null) (Client)

Responses

Response samples

Content type
application/json
[
  • {
    }
]