Sankey Usage and Data Format

Key features:

  • The diagram visualizes relationships between two distinct fields or categories. For example, source to destination IP traffic flows

  • Band thickness indicates the magnitude of the relationship

  • Interactive hovering shows detailed flow information

  • The diagram can be created via the web interface or using the sankey() function in queries.

The Sankey widget requires the data input to have the following fields:

Field Type Description
source string The ID of the source node (left side). This value will also be used as the label of the node.
target string The ID of the target node (right side). This value will also be used as the label of the node.
weight number The value that is used to determine the size of the edge between source and target, scaled automatically. This could be used to represent the traffic between two IP addresses.

When creating a Sankey widget, ensure that these input fields are named as expected.