For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/dashboards/widgets/list.md. A documentation index is available at /llms.txt.

List Widget

The list widget displays a list of events and issues, which can come from a variety of sources such as Logs, RUM, or Events. Search and query across sources to narrow down the events you want the widget to highlight and display.

List widget displaying error tracking issues

List widget displaying a list of errors, their error count and volume.

Setup

List widget configuration modal

Configuration

  1. Choose the type of data to graph. The list widget supports many data sources, depending on which products are enabled for your organization. For the full list, see Supported data sources.

  2. Set display preferences. On screenboards and notebooks, choose whether your widget has a custom timeframe or uses the global timeframe.

  3. Optional: Give your graph a title (or leave blank for suggested title).

Supported data sources

The data sources available in the source dropdown depend on which products are enabled for your organization. The following table lists each data source, the data it displays, and any product requirements. Where available, click a data source in the table to navigate to its configuration options.

Data sources marked (Preview) are in Preview and might not be available in your organization.

Data sourceDescriptionRequirements
Audit TrailAudit events that track activity across your organization.Audit Trail
CasesCases that track and triage work across teams.Case Management
CD Deployments (Preview)Continuous delivery deployment executions.CD Visibility
CI PipelineCI pipeline executions.CI Pipeline Visibility
CI TestCI test runs.Test Optimization
Data Observability (Preview)Data assets, such as datasets and lineage, from Data Observability.Data Observability
Database Recommendations (Preview)Optimization recommendations from Database Monitoring.Database Monitoring
DDSQL EditorResults of a DDSQL query.None
Detection Rules (Preview)Security detection rules.Cloud SIEM or Cloud Security
Developer Portal (Preview)Views of software entities, including services, APIs, and data stores.Internal Developer Portal
EventsEvents from the Events Explorer.None
IncidentsIncidents from Incident Management.Incident Management
Infrastructure Resources (Preview)Infrastructure resources, such as hosts and containers.Infrastructure Monitoring
IssuesError Tracking issues across APM, Logs, RUM, and other sources.Error Tracking
LLM ObservabilityTraces and spans from LLM Observability.LLM Observability
LogsIndividual log events. You can also group logs by patterns or transactions.Log Management
NotebookData from a notebook cell.Notebooks
On-CallOn-Call events and pages.Datadog On-Call
Product Analytics (Preview)Product analytics events.Product Analytics
RecommendationsCloud cost optimization recommendations from Cloud Cost Management.Cloud Cost Management
Reference TablesRows from a reference table.Reference Tables
RUMReal User Monitoring events.Real User Monitoring
Security Signals (Preview)Security signals generated by detection rules.Cloud SIEM
SpansAPM spans.APM
Watchdog AlertsAlerts surfaced by Watchdog.None
Workload Protection Agent (Preview)Workload Protection events from the Datadog Agent.Workload Protection

Note: The Recommendations data source displays Cloud Cost Management recommendations only. APM recommendations are not available as a List widget data source. If Cloud Cost Management is not configured for your organization, the widget displays a Not Accessible message. This indicates that the data source requires Cloud Cost Management, rather than that you lack permissions.

Options

Each data source has its own configuration. For most data sources, you can:

  • Select which columns to display.
  • Sort the list by choosing a column and a direction (ascending or descending). The available sort columns are the columns displayed in the widget.
  • Narrow results with a search query.

The following data sources have additional or different options.

Sort by (ascending or descending):

  • Alert count

  • Last created

  • Case key

  • Last updated

  • Priority

  • Status

  • Unassigned

Select a Level to display: Pipeline, Stage, Job, Step, or Custom.

Select an entity type (database table or database column). The available columns and sort options depend on the entity type.

Sort by (ascending or descending):

  • Severity

  • Type

  • First seen

  • Last seen

Sortable columns include Name, Creation Date, Last Update Date, Enabled, Severity, and Source. You can also select a rule product to filter the rules shown.

Reporting format size:

  • Small (title only) (default)

  • Large (full event)

Sort by (ascending or descending):

  • Created

  • Detected

  • Modified

  • Resolved

  • Severity

  • Status

  • Title

Select a Resource type to display, such as Pods, Containers, Deployments, Services, or Nodes. The available columns and sort options depend on the resource type.

Sort by:

  • Relevance (default)
  • Count
  • Newest
  • Impacted sessions (RUM issues only)

The available columns depend on the issue source (Logs, APM, or RUM).

Note: Changing the sort selection does not change the columns displayed. To sort by impacted sessions and see it in the widget, you must also add the “Impacted Sessions” column in the graph editor.

Group by:

  • Patterns
  • Transactions

Depending on your logs configuration, you can also select a storage location: Standard Indexes, Standard Indexes + Flex Logs, or Online Archives.

For the message column, you can choose how many lines to display (1, 3, or 10).

These data sources display rows from a saved dataset or table:

  • Notebook and DDSQL Editor: select a published dataset.
  • Reference Tables: select a reference table.
  • Developer Portal: select a software entity table, such as services, APIs, or datastores.

For these data sources, you can:

  • Set Display first to limit the number of rows (10, 25, 50, 100, 500, or 1000, or a custom value).

  • Toggle Show All Columns, or select up to 12 columns to display.

  • Sort by clicking a column’s sort icon.

  • Filter the rows with a search query.

Select a Team, and optionally add Tags to filter the events shown.

The columns for the Recommendations data source are fixed and cannot be customized.

These data sources support a search query but do not provide a sort option. Watchdog Alerts displays a fixed set of fields.

For the Content column, you can choose how many lines to display (1, 3, or 10).

API

This widget can be used with the Dashboards API. See the following table for the widget JSON schema definition:

Expand All

Field

Type

Description

description

string

The description of the widget.

legend_size

string

Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".

requests [required]

[object]

Request payload used to query items.

columns [required]

[object]

Widget columns.

field [required]

string

Widget column field.

width [required]

enum

Widget column width. Allowed enum values: auto,compact,full

query [required]

object

Updated list stream widget.

assignee_uuids

[string]

Filter by assignee UUIDs. Usable only with issue_stream.

clustering_pattern_field_path

string

Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream.

compute

[object]

Compute configuration for the List Stream Widget. Compute can be used only with the logs_transaction_stream (from 1 to 5 items) list stream source.

aggregation [required]

enum

Aggregation value. Allowed enum values: count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min

Show 5 more,max,avg,earliest,latest,most_frequent

facet

string

Facet name.

data_source [required]

enum

Source from which to query items to display in the stream. apm_issue_stream, rum_issue_stream, and logs_issue_stream are deprecated. Use issue_stream instead. Allowed enum values: logs_stream,audit_stream,ci_pipeline_stream,ci_test_stream,rum_issue_stream,apm_issue_stream,trace_stream,logs_issue_stream,logs_pattern_stream,logs_transaction_stream

Show 4 more,event_stream,rum_stream,llm_observability_stream,issue_stream

default: logs_stream

event_size

enum

Size to use to display an event. Allowed enum values: s,l

group_by

[object]

Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream (one group by item is required) list stream source.

facet [required]

string

Facet name.

indexes

[string]

List of indexes.

persona

enum

Persona filter for the issue_stream data source. Allowed enum values: all,browser,mobile,backend

query_string [required]

string

Widget query.

sort

object

Which column and order to sort by

column [required]

string

Facet path for the column

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

states

[string]

Filter by issue states. Usable only with issue_stream.

storage

string

Option for storage location. Feature in Private Beta.

suspected_causes

[string]

Filter by suspected causes. Usable only with issue_stream.

team_handles

[string]

Filter by team handles. Usable only with issue_stream.

version

enum

Version of the query for the logs transaction stream widget. When omitted, v1 query behavior is preserved. Set to sequential_query to use v2 behavior. This feature is in Preview. Allowed enum values: sequential_query

response_format [required]

enum

Widget response format. Allowed enum values: event_list

show_legend

boolean

Whether or not to display the legend on this widget.

time

 <oneOf>

Time setting for the widget.

Option 1

object

Wrapper for live span

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w

Show 7 more,1mo,3mo,6mo,week_to_date,month_to_date,1y,alert

Option 2

object

Used for arbitrary live span times, such as 17 minutes or 6 hours.

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

type [required]

enum

Type "live" denotes a live span in the new format. Allowed enum values: live

unit [required]

enum

Unit of the time span. Allowed enum values: minute,hour,day,week,month,year

value [required]

int64

Value of the time span.

Option 3

object

Used for fixed span times, such as 'March 1 to March 7'.

from [required]

int64

Start time in milliseconds since epoch.

hide_incomplete_cost_data

boolean

Whether to hide incomplete cost data in the widget.

to [required]

int64

End time in milliseconds since epoch.

type [required]

enum

Type "fixed" denotes a fixed span. Allowed enum values: fixed

title

string

Title of the widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the list stream widget. Allowed enum values: list_stream

default: list_stream

{
  "description": "string",
  "legend_size": "string",
  "requests": [
    {
      "columns": [
        {
          "field": "content",
          "width": "compact"
        }
      ],
      "query": {
        "assignee_uuids": [],
        "clustering_pattern_field_path": "message",
        "compute": [
          {
            "aggregation": "count",
            "facet": "resource_name"
          }
        ],
        "data_source": "logs_stream",
        "event_size": "string",
        "group_by": [
          {
            "facet": "resource_name"
          }
        ],
        "indexes": [],
        "persona": "string",
        "query_string": "@service:app",
        "sort": {
          "column": "",
          "order": "desc"
        },
        "states": [],
        "storage": "indexes",
        "suspected_causes": [],
        "team_handles": [],
        "version": "string"
      },
      "response_format": "event_list"
    }
  ],
  "show_legend": false,
  "time": {
    "hide_incomplete_cost_data": false,
    "live_span": "5m"
  },
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "list_stream"
}

Further Reading