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

# FlowIQ

> This section provides the purpose, elements, and actions performed on the FlowIQ pages.

This section provides the purpose, elements, and actions performed on the
**FlowIQ** pages.

<Tabs>
  <Tab title="Overview">
    ## Purpose

    The **Overview** page displays network flow data analysis with traffic metrics,
    source and destination IP visualizations, and flow statistics for the selected
    time period.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/monitor/flowiq-overview.png"
}
        alt="FlowIQ: Overview"
        width="100%"
      />
    </Frame>

    * **Time Period**: Dropdown to select time period (e.g., Last 60 Minutes).
    * **Start**: Date and time picker for start time.
    * **End**: Date and time picker for end time (can be set to 'Now').
    * **Enter IP Address or Port**: Filter input for IP address or port.
    * **Refresh Data**: Button to refresh the displayed data.
    * **Load View**: Button to load a saved view configuration.
    * **Save View**: Button to save the current view configuration.
    * **Apply**: Button to apply the selected filters and time period.
    * **View By**: Dropdown to select view metric (e.g., Traffic Bytes).
    * **Total Traffic**: Card displaying total traffic metric.
    * **Total Packet Count**: Card displaying total packet count metric.
    * **Unique Source IPs**: Card displaying unique source IPs count.
    * **Unique Destination IPs**: Card displaying unique destination IPs count.
    * **Source IP**: Dropdown for source IP visualization.
    * **Destination IP**: Dropdown for destination IP visualization.
    * **Source Port**: Chart/visualization for source port data.
    * **Destination Port**: Chart/visualization for destination port data.
    * **IP Version and Protocol**: Chart/visualization for IP version and protocol
      data.
    * **Autonomous Systems**: Dropdown for autonomous systems visualization.
    * **Flow Exporters**: Dropdown for flow exporters visualization.
    * **Flow Locality**: Dropdown for flow locality visualization.
    * **Data Integrity and FlowIQ**: Expandable information panel about NetFlow
      sampling rate and data integrity.
    * **NetFlow Settings**: Button that navigates to NetFlow configuration settings.

    ## Actions

    <AccordionGroup>
      <Accordion title="View FlowIQ Overview">
        To view FlowIQ flow data and metrics:

        1. Go to **Monitor** > **FlowIQ** > **Overview**.
        2. The Overview page appears with **Total Traffic**, **Total Packet Count**, **Unique Source IPs**, and **Unique Destination IPs** cards and visualizations.
        3. Use **Time Period**, **Start**, and **End** to set the time range, and **Enter IP Address or Port** to filter. Click **Apply**.
        4. Optionally, use **View By**, **Source IP**, **Destination IP**, **Source Port**, **Destination Port**, **IP Version and Protocol**, **Autonomous Systems**, **Flow Exporters**, or **Flow Locality** to change visualizations.
        5. Optionally, use **Load View** or **Save View** to manage view configurations, **Refresh Data** to refresh, or **NetFlow Settings** to open NetFlow configuration.

        The Overview displays flow analysis for the selected time period and filters.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                  |
        | ---------------------- | ------------------------------------------------------------ |
        | Timestamp              | Shows the timestamp when the flow record was captured.       |
        | Source Address         | Shows the source IP address of the network flow.             |
        | Destination Address    | Shows the destination IP address of the network flow.        |
        | Direction              | Shows the direction of the network flow (ingress or egress). |
        | Bytes                  | Shows the total number of bytes transferred in the flow.     |
        | Packets                | Shows the total number of packets transferred in the flow.   |
        | Host                   | Shows the host identifier associated with the flow.          |
        | Duration               | Shows the duration of the network flow.                      |
        | Throughput             | Shows the throughput rate of the network flow.               |
        | Ingress Interface Name | Shows the name of the ingress interface for the flow.        |
        | Egress Interface Name  | Shows the name of the egress interface for the flow.         |
        | Gateway Host Name      | Shows the host name of the gateway processing the flow.      |
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Trends">
    ## Purpose

    The **Trends** page displays time-series charts showing traffic usage trends,
    source IP trends, and destination IP trends over the selected time period.

    ## Elements

    <Frame>
      <img src={"/images/reference/ui/monitor/flowiq-trends.png"} alt="FlowIQ: Trends" width="100%" />
    </Frame>

    * **Time Period**: Dropdown to select time period (e.g., Last 60 Minutes).
    * **Start**: Date and time picker for start time.
    * **End**: Date and time picker for end time (can be set to 'Now').
    * **Enter IP Address or Port**: Filter input for IP address or port.
    * **Refresh Data**: Button to refresh the displayed data.
    * **Load View**: Button to load a saved view configuration.
    * **Save View**: Button to save the current view configuration.
    * **Apply**: Button to apply the selected filters and time period.
    * **Traffic Usage**: Time-series chart showing traffic usage trends.
    * **Source IP**: Dropdown to select source IP for trend analysis.
    * **View By: Traffic Bytes**: Dropdown to select metric for source IP trends
      (e.g., Traffic Bytes).
    * **Destination IP**: Dropdown to select destination IP for trend analysis.
    * **View By: Traffic Bytes**: Dropdown to select metric for destination IP
      trends (e.g., Traffic Bytes).

    ## Actions

    <AccordionGroup>
      <Accordion title="View FlowIQ Trends">
        To view traffic usage trends:

        1. Go to **Monitor** > **FlowIQ** > **Trends**.
        2. The Trends page appears with **Traffic Usage** and source/destination IP trend charts.
        3. Use **Time Period**, **Start**, and **End** to set the time range, and **Enter IP Address or Port** to filter. Click **Apply**.
        4. Optionally, use **Source IP** or **Destination IP** and their **View By** dropdowns to change trend metrics. Use **Load View**, **Save View**, or **Refresh Data** as needed.

        The Trends page shows time-series traffic and IP trends for the selected period.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                           |
        | ---------------------- | ----------------------------------------------------- |
        | Key                    | Shows the key identifier for the trend data point.    |
        | Value                  | Shows the value associated with the trend data point. |
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Geolocation">
    ## Purpose

    The **Geolocation** page displays an interactive world map showing the
    geolocation of network flows with source and destination country visualizations.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/monitor/flowiq-geolocation.png"
}
        alt="FlowIQ: Geolocation"
        width="100%"
      />
    </Frame>

    * **Time Period**: Dropdown to select time period (e.g., Last 60 Minutes).
    * **Start**: Date and time picker for start time.
    * **End**: Date and time picker for end time (can be set to 'Now').
    * **Enter IP Address or Port**: Filter input for IP address or port.
    * **Refresh Data**: Button to refresh the displayed data.
    * **Load View**: Button to load a saved view configuration.
    * **Save View**: Button to save the current view configuration.
    * **Apply**: Button to apply the selected filters and time period.
    * **World Map**: Interactive world map showing geolocation of network flows.
    * **Zoom In**: Button to zoom in on the map.
    * **Reset View**: Button to reset the map view to default.
    * **Source Country**: Dropdown to select source country for geolocation
      visualization.
    * **Destination Country**: Dropdown to select destination country for
      geolocation visualization.

    ## Actions

    <AccordionGroup>
      <Accordion title="View FlowIQ Geolocation">
        To view flow geolocation on the map:

        1. Go to **Monitor** > **FlowIQ** > **Geolocation**.
        2. The Geolocation page appears with the **World Map** showing flow geolocation.
        3. Use **Time Period**, **Start**, and **End** to set the time range, and **Enter IP Address or Port** to filter. Click **Apply**.
        4. Optionally, use **Source Country** or **Destination Country** to filter by country, **Zoom In** or **Reset View** to adjust the map, and **Load View**, **Save View**, or **Refresh Data** as needed.

        The map displays geolocation of network flows for the selected period.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                             |
        | ---------------------- | ----------------------------------------------------------------------- |
        | World Map              | Displays an interactive world map showing geolocation of network flows. |
        | Zoom In                | Zooms in on the map view.                                               |
        | Reset View             | Resets the map view to default.                                         |
        | Source Country         | Selects source country for geolocation visualization.                   |
        | Destination Country    | Selects destination country for geolocation visualization.              |
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Records">
    ## Purpose

    The **Records** page displays a detailed table of network flow records with
    columns for timestamp, source and destination addresses, direction, bytes,
    packets, host, duration, throughput, interface names, and gateway host name.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/monitor/flowiq-records.png"
}
        alt="FlowIQ: Records"
        width="100%"
      />
    </Frame>

    * **Time Period**: Dropdown to select time period (e.g., Last 60 Minutes).
    * **Start**: Date and time picker for start time.
    * **End**: Date and time picker for end time (can be set to 'Now').
    * **Enter IP Address or Port**: Filter input for IP address or port.
    * **Refresh Data**: Button to refresh the displayed data.
    * **Load View**: Button to load a saved view configuration.
    * **Save View**: Button to save the current view configuration.
    * **Apply**: Button to apply the selected filters and time period.
    * **Search**: Search box for filtering records (may be unavailable).
    * **Show filters**: Button to show/hide filters.
    * **Select columns**: Button to select visible columns.
    * **Export**: Button to export records data.

    ## Actions

    <AccordionGroup>
      <Accordion title="View Flow Records">
        To view flow records in table form:

        1. Go to **Monitor** > **FlowIQ** > **Records**.
        2. The Records page appears with a table of flow records (timestamp, source/destination, direction, bytes, packets, host, duration, throughput, interfaces, gateway).
        3. Use **Time Period**, **Start**, and **End** to set the time range, and **Enter IP Address or Port** to filter. Click **Apply**.
        4. Optionally, use **Search**, **Show filters**, **Select columns**, **Export**, **Load View**, **Save View**, or **Refresh Data** as needed.

        The Records table shows detailed flow data for the selected period.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                  |
        | ---------------------- | ------------------------------------------------------------ |
        | Timestamp              | Shows the timestamp when the flow record was captured.       |
        | Source Address         | Shows the source IP address of the network flow.             |
        | Destination Address    | Shows the destination IP address of the network flow.        |
        | Direction              | Shows the direction of the network flow (ingress or egress). |
        | Bytes                  | Shows the total number of bytes transferred in the flow.     |
        | Packets                | Shows the total number of packets transferred in the flow.   |
        | Host                   | Shows the host identifier associated with the flow.          |
        | Duration               | Shows the duration of the network flow.                      |
        | Throughput             | Shows the throughput rate of the network flow.               |
        | Ingress Interface Name | Shows the name of the ingress interface for the flow.        |
        | Egress Interface Name  | Shows the name of the egress interface for the flow.         |
        | Gateway Host Name      | Shows the host name of the gateway processing the flow.      |
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Flows">
    ## Purpose

    The **Flows** page displays network flow analysis with summary metrics including
    total traffic, packet count, unique source and destination IPs, and flow
    visualization options.

    ## Elements

    <Frame>
      <img src={"/images/reference/ui/monitor/flowiq-flows.png"} alt="FlowIQ: Flows" width="100%" />
    </Frame>

    * **Time Period**: Dropdown to select time period (e.g., Last 60 Minutes).
    * **Start**: Date and time picker for start time.
    * **End**: Date and time picker for end time (can be set to 'Now').
    * **Enter IP Address or Port**: Filter input for IP address or port.
    * **Refresh Data**: Button to refresh the displayed data.
    * **Load View**: Button to load a saved view configuration.
    * **Save View**: Button to save the current view configuration.
    * **Apply**: Button to apply the selected filters and time period.
    * **View By**: Dropdown to select view metric (e.g., Traffic Bytes).
    * **Total Traffic**: Card displaying total traffic metric.
    * **Total Packet Count**: Card displaying total packet count metric.
    * **Unique Source IPs**: Card displaying unique source IPs count.
    * **Unique Destination IPs**: Card displaying unique destination IPs count.
    * **Show Hostnames**: Checkbox to toggle display of hostnames in flow data.

    ## Actions

    <AccordionGroup>
      <Accordion title="View Flows Summary">
        To view flow summary metrics and visualizations:

        1. Go to **Monitor** > **FlowIQ** > **Flows**.
        2. The Flows page appears with **Total Traffic**, **Total Packet Count**, **Unique Source IPs**, and **Unique Destination IPs** and flow visualizations.
        3. Use **Time Period**, **Start**, and **End** to set the time range, and **Enter IP Address or Port** to filter. Click **Apply**.
        4. Optionally, use **View By** to change the metric, **Show Hostnames** to toggle hostnames, and **Load View**, **Save View**, or **Refresh Data** as needed.

        The Flows page displays flow analysis summary for the selected period.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                  |
        | ---------------------- | ------------------------------------------------------------ |
        | View By                | Selects the metric to view (e.g., Traffic Bytes).            |
        | Total Traffic          | Shows the total traffic metric for the selected time period. |
        | Total Packet Count     | Shows the total packet count for the selected time period.   |
        | Unique Source IPs      | Shows the count of unique source IP addresses.               |
        | Unique Destination IPs | Shows the count of unique destination IP addresses.          |
        | Show Hostnames         | Toggles display of hostnames in flow data.                   |
      </Accordion>
    </AccordionGroup>
  </Tab>
</Tabs>