> ## Documentation Index
> Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Network Throughput

> Retrieves time-series data representing the average network throughput (in bits per second) across specified sites over a given time window. Use this endpoint to visualize traffic rates for dashboards and reports.



## OpenAPI

````yaml /api/en/monitoring-metrics.yaml get /metrics/dashboard/throughput
openapi: 3.0.3
info:
  title: Altostrat Monitoring & Metrics API
  version: 1.0.0
  description: >-
    Retrieve portal-facing metrics through the public `/metrics` gateway path,
    including dashboards, WAN tunnels, interfaces, ARP entries, syslogs, BGP,
    and DNS reports.
servers:
  - url: https://v1.api.altostrat.io
security:
  - bearerAuth: []
tags:
  - name: Dashboard
    description: High-level, aggregated metrics for network performance and data usage.
  - name: WAN Tunnels & Performance
    description: >-
      Endpoints for managing and retrieving performance data from SD-WAN
      tunnels.
  - name: Site Interfaces & Metrics
    description: >-
      Endpoints for listing network interfaces at a site and fetching their
      traffic metrics.
  - name: Device Health & Status
    description: Endpoints for monitoring the health and status of network devices.
  - name: ARP Inventory
    description: >-
      Endpoints for querying and managing the Address Resolution Protocol (ARP)
      table to discover devices on the network.
  - name: Network Logs
    description: Access to system, DNS, and BGP logs for diagnostics and security analysis.
  - name: Grafana Dashboards
    description: List Grafana dashboards, query dashboard panels, and export panel data.
  - name: Prometheus Querying
    description: >-
      Discover available metrics and labels, then execute Prometheus queries
      scoped to your workspace.
paths:
  /metrics/dashboard/throughput:
    get:
      tags:
        - Dashboard
      summary: Get Network Throughput
      description: >-
        Retrieves time-series data representing the average network throughput
        (in bits per second) across specified sites over a given time window.
        Use this endpoint to visualize traffic rates for dashboards and reports.
      parameters:
        - name: start_time
          in: query
          required: false
          description: >-
            The start of the time window in ISO 8601 format
            (YYYY-MM-DDTHH:MM:SS). Defaults to 4 hours ago.
          schema:
            type: string
            format: date-time
            example: '2025-10-29T08:00:00'
        - name: end_time
          in: query
          required: false
          description: >-
            The end of the time window in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
            Defaults to the current time.
          schema:
            type: string
            format: date-time
            example: '2025-10-29T12:00:00'
        - name: bucket_interval_minutes
          in: query
          required: false
          description: The time interval in minutes for aggregating data points.
          schema:
            type: integer
            default: 5
            example: 15
        - name: site_ids[]
          in: query
          required: false
          description: >-
            An array of Site UUIDs to filter the results. If omitted, data from
            all accessible sites will be aggregated.
          schema:
            type: array
            items:
              type: string
              format: uuid
          example:
            - d8f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8
      responses:
        '200':
          description: A list of throughput data points aggregated into time buckets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThroughputResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ThroughputResponse:
      type: array
      items:
        $ref: '#/components/schemas/ThroughputDatapoint'
    ThroughputDatapoint:
      type: object
      properties:
        time_slot:
          type: string
          format: date-time
          description: The start time of the aggregation bucket.
          example: '2025-10-29 10:00:00'
        average_in_bps:
          type: number
          format: float
          description: >-
            The average inbound throughput in bits per second for this time
            slot.
          example: 12500000.5
        average_out_bps:
          type: number
          format: float
          description: >-
            The average outbound throughput in bits per second for this time
            slot.
          example: 2350000.75
        total_average_throughput_bps:
          type: number
          format: float
          description: The combined average throughput in bits per second.
          example: 14850001.25
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: A broad category for the error (e.g., 'invalid_request_error').
          example: invalid_request_error
        code:
          type: string
          description: A short, unique string identifying the specific error.
          example: parameter_invalid
        message:
          type: string
          description: A human-readable description of what went wrong.
          example: The provided 'siteId' is not a valid UUID.
        doc_url:
          type: string
          description: >-
            A direct link to the documentation page for this specific error
            code.
          example: https://docs.altostrat.io/errors/parameter_invalid
  responses:
    BadRequest:
      description: Bad Request - The request was malformed or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized - The request lacks valid authentication credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````