Dashboard API - ServiceNow Fluent

reference australia Updated Sep 10, 2026 11 min read fluent-dashboard-api.md
Raw file servicenow.com

The Dashboard API defines dashboards [par_dashboard] for organizing and sharing data visually.

Note: For the latest ServiceNow Fluent API documentation and examples, see the ServiceNow Fluent API reference and ServiceNow SDK examples repository on GitHub.

A dashboard consists of tabs, widgets, visibilities, and permissions. Each tab contains widgets that display data visualizations, headings, rich text, and other components.

Dashboards can be used as the home page of a workspace by referring to one or more workspaces from the visibilities array of the Dashboard object. To create a workspace, see Workspace API - ServiceNow Fluent.

For general information about dashboards, see Dashboards in Platform Analytics.

Parent Topic:ServiceNow Fluent API reference

Related topics

ServiceNow Fluent

Dashboard object

Create a shareable dashboard [par_dashboard] with data visualizations, filters, tabs, widgets, permissions, and visibility rules.

Name

Type

Description

$id

String or Number

Required. A unique ID for the metadata object. When you build the application, this ID is hashed into a unique sys_id. For more information, see ServiceNow Fluent language constructs.Format: Now.ID['String' or Number]

name

String

Required. A name to display for the dashboard.

active

Boolean

Flag that indicates whether the dashboard is active.Default: true

tabs

Array

A list of tabs to display in the dashboard. For more information, see tabs array.

permissions

Array

A list of user permissions required to access the dashboard. For more information, see permissions array.

visibilities

Array

A list of visibility rules that control which UX experiences display the dashboard. For more information, see visibilities array.Default: A default visibility rule with sys_id 08c73d60537101100834ddeeff7b1287 is used.

$meta

Object

Metadata for the application metadata.With the installMethod property, you can map the application metadata to an output directory that loads only in specific circumstances.

JavaScript
$meta: {      installMethod: 'String'}

Valid values for installMethod:

  • demo: Outputs the application metadata to the metadata/unload.demo directory to be installed with the application when the Load demo data option is selected.
  • first install: Outputs the application metadata to the metadata/unload directory to be installed only the first time an application is installed on an instance.
```javascript import { Dashboard } from "@servicenow/sdk/core";

Dashboard({ $id: Now.ID["incident_management_dashboard"], name: "Incident Management Dashboard", tabs: [ { $id: Now.ID["incident_overview_tab"], name: "Overview", widgets: [ // Single Score: Total Open Incidents { $id: Now.ID["total_open_incidents_widget"], component: "single-score", componentProps: { dataSources: [ { label: "Incident", sourceType: "table", tableOrViewName: "incident", filterQuery: "", reportSourceSysId: "d94d6f62d7632100b96d45a3ce6103d2", id: "dGFibGVpbmNpZGVudDE3NjMzOTI0OTY5ODE=" } ], headerTitle: "Open Incidents", metrics: [ { dataSource: "dGFibGVpbmNpZGVudDE3NjMzOTI0OTY5ODE=", id: "ZEdGaWJHVnBibU5wWkdWdWRERTNOak16T1RJME9UWTVPREU9MTc2MzM5MjQ5Nzc5OQ==", aggregateFunction: "COUNT", axisId: "primary" } ], sortBy: "value" }, height: 14, width: 14, position: { x: 0, y: 0 } }, // Vertical Bar: Incidents by Priority { $id: Now.ID["incidents_by_priority_widget"], component: "vertical-bar", componentProps: { dataSources: [ { label: "Incident", sourceType: "table", tableOrViewName: "incident", filterQuery: "", reportSourceSysId: "d94d6f62d7632100b96d45a3ce6103d2", id: "dGFibGVpbmNpZGVudDE3NjI3OTU4OTg3NDA=" } ], headerTitle: "Incidents by Priority", metrics: [ { dataSource: "dGFibGVpbmNpZGVudDE3NjI3OTU4OTg3NDA=", id: "ZEdGaWJHVnBibU5wWkdWdWRERTNOakkzT1RVNE9UZzNOREE9MTc2Mjc5NTg5OTM5OA==", aggregateFunction: "COUNT", axisId: "primary" } ], groupBy: [ { groupBy: [ { dataSource: "dGFibGVpbmNpZGVudDE3NjI3OTU4OTg3NDA=", groupByField: "priority" } ], maxNumberOfGroups: 10, numberOfGroupsBasedOn: "NO_OF_GROUP_BASED_ON_PER_METRIC", showOthers: false, disableRanges: false } ], sortBy: "value" }, height: 14, width: 17, position: { x: 14, y: 0 } }, // Vertical Bar: Incidents by State { $id: Now.ID["incidents_by_state_widget"], component: "vertical-bar", componentProps: { dataSources: [ { label: "Incident", sourceType: "table", tableOrViewName: "incident", filterQuery: "", reportSourceSysId: "d94d6f62d7632100b96d45a3ce6103d2", id: "dGFibGVpbmNpZGVudDE3NjI3OTU4OTg3NDA=" } ], headerTitle: "Incidents by State", metrics: [ { dataSource: "dGFibGVpbmNpZGVudDE3NjI3OTU4OTg3NDA=", id: "ZEdGaWJHVnBibU5wWkdWdWRERTNOakkzT1RVNE9UZzNOREE9MTc2Mjc5NTg5OTM5OA==", aggregateFunction: "COUNT", axisId: "primary" } ], groupBy: [ { groupBy: [ { dataSource: "dGFibGVpbmNpZGVudDE3NjI3OTU4OTg3NDA=", groupByField: "state" } ], maxNumberOfGroups: 10, numberOfGroupsBasedOn: "NO_OF_GROUP_BASED_ON_PER_METRIC", showOthers: false, disableRanges: false } ], sortBy: "value" }, height: 14, width: 17, position: { x: 31, y: 0 } } ] }, { $id: Now.ID["incident_trends_tab"], name: "Trends", widgets: [] // Can be populated later or left empty } ], visibilities: [ { $id: Now.ID["incident_dashboard_visibility"], experience: incidentWorkspace } ], permissions: [] })

JavaScript
The workspace referenced is defined using the Workspace object:
```javascriptimport { Workspace } from "@servicenow/sdk/core";
export const myWorkspace = Workspace({  $id: Now.ID["my_workspace"],  title: "My Workspace",  path: "my-workspace",  tables: ["incident"],  listConfig: myListConfig})

tabs array

Create tabs [par_dashboard_tab] that contain widgets for a dashboard.

Within a dashboard, tabs are ordered using their position in the array.

Name

Type

Description

$id

String or Number

Required. A unique ID for the metadata object. When you build the application, this ID is hashed into a unique sys_id. For more information, see ServiceNow Fluent language constructs.Format: Now.ID['String' or Number]

name

String

Required. A name to display on the tab.

active

Boolean

Flag that indicates whether the tab is active.Default: true

Note: This flag is not used in the application and its value does not change the status of the tab.

widgets

Array

A list of widgets to display in the tab. For more information, see widgets array.
```javascript tabs: [ { $id: Now.ID["my_dashboard_tab1"], name: "Overview", widgets: [ { $id: Now.ID["my_dashboard_widget_1"], component: "single-score", componentProps: { dataSources: [ { label: "Incident", sourceType: "table", tableOrViewName: "incident", filterQuery: "", reportSourceSysId: "d94d6f62d7632100b96d45a3ce6103d2", id: "dGFibGVpbmNpZGVudDE3NjMzOTI0OTY5ODE=" } ], headerTitle: "Open Incidents", metrics: [ { dataSource: "dGFibGVpbmNpZGVudDE3NjMzOTI0OTY5ODE=", id: "ZEdGaWJHVnBibU5wWkdWdWRERTNOak16T1RJME9UWTVPREU9MTc2MzM5MjQ5Nzc5OQ==", aggregateFunction: "COUNT", axisId: "primary" } ], sortBy: "value" }, height: 14, width: 14, position: { x: 0, y: 0 } } ] } ] ```

widgets array

Create widgets [par_dashboard_widget] within a tab in a grid layout.

Dashboards use a 48-point grid system for positioning widgets.

Name

Type

Description

$id

String or Number

Required. A unique ID for the metadata object. When you build the application, this ID is hashed into a unique sys_id. For more information, see ServiceNow Fluent language constructs.Format: Now.ID['String' or Number]

component

Reference or String

Required. The name of a component (such as line or single-score) or the sys_id of a component from the UX Macroponent Definition [sys_ux_macroponent] table to display as a widget.Component names aren't case sensitive and resolve to their sys_ids during the build process.

height

Number

Required. The height of the widget in grid units.

width

Number

Required. The width of the widget in grid units.Maximum value: 48

position

Object

Required. The position of the widget in the grid layout with x and y properties. For example, a value of { x: 0, y: 0 } positions the widget in the top-left corner of the grid.

componentProps

Object

The property configuration of a component. For more information, see componentProps object.
```javascript widgets: [ { $id: Now.ID['incident-count-chart'], component: 'vertical-bar', // Vertical bar chart componentProps: { title: 'Incident Count', dataSource: 'incident', aggregation: 'count' }, height: 8, width: 6, position: { x: 0, y: 0 }, }, { $id: Now.ID['recent-incidents-list'], component: 'list', // List component componentProps: { table: 'incident', filter: 'active=true', limit: 10, columns: ['number', 'short_description', 'priority', 'state'] }, height: 8, width: 6, position: { x: 6, y: 0 }, } ], }, { $id: Now.ID['analytics'], name: 'Analytics', widgets: [ { $id: Now.ID['metrics-widget'], component: 'single-score', // Single score component componentProps: { title: 'Key Metrics', scoreSize: 'large' }, height: 12, width: 12, position: { x: 0, y: 0 }, } ] ```

componentProps object

Configure the properties of widgets [par_dashboard_widget].

The available properties are determined by the component specified with the component property of the Dashboard object.

  • Trend data components require the dataSources, metrics, and trendBy properties. The groupBy property is optional.
  • Group data components require the dataSources, metrics, and groupBy properties. The trendBy property isn't supported in these visualizations.
  • Simple data components require the dataSources and metrics properties. The groupBy and trendBy properties aren't supported in these visualizations.

Name

Type

Description

dataSources

Array

A list of data sources for the component. For example:```javascript dataSources: [ { label: "Incident", // Human-readable label sourceType: "table", // Type of data source tableOrViewName: "incident", // ServiceNow table name filterQuery: "", // Optional encoded query filter id: "data_source_1" // Unique data source ID }, ... ]

Text
</td></tr><tr><td>
headerTitle
</td><td>
String
</td><td>
A title to display with the widget.
</td></tr><tr><td>
metrics
</td><td>
Array
</td><td>
A list of metrics to measure for the data source. For example:```javascriptmetrics: [    {        dataSource: 'data_source_1',  // Must match dataSource id        id: 'metric_1',  // Unique metric ID        aggregateFunction: 'AVG',  // COUNT, SUM, AVG, MIN, MAX, COUNT_DISTINCT        aggregateField: 'business_duration'  // Field to be used for aggregation.        axisId: 'primary',  // Which axis to display the series    },...]

groupBy

Array

A list of configurations for grouping and organizing data by data source. For example:```javascript groupBy: [ { groupBy: [ { dataSource: "data_source_1", // Must match dataSource id groupByField: "state" // Field to group by } ], maxNumberOfGroups: 10, // Maximum categories to show showOthers: false // Show "Others" category }, ... ]

Text
</td></tr><tr><td>
trendBy
</td><td>
Object
</td><td>
A configuration for trend charts. For example:```javascripttrendBy: {  "trendByFrequency": "year", // Frequency of the trend (date, week, month, year)  "trendByFields": [    {      "field": "sys_created_on", // Field to trend on (from the table of the dataSource)      "metric": "metric_1" // ID of the metric    }  ]}

sortBy

String

The method of sorting data.Valid values:

  • value
  • label
  • field
In the following example, the `line` component, which is a trend data type visualization, is used to show how a metric changes over time.
JavaScript
{    component: 'line',    componentProps: {        dataSources: [            {                label: 'Incident',                sourceType: 'table',                tableOrViewName: 'incident',                filterQuery: '',                id: 'data_source_1',            },        ],        headerTitle: 'Incidents by State',        metrics: [            {                dataSource: 'data_source_1',                id: 'metric_1',                aggregateFunction: 'COUNT',                axisId: 'primary',            },        ],        trendBy: {            trendByFrequency: "year",            trendByFields: [                {                    field: "sys_created_on",                    metric: "metric_1"                }            ]        },    },    height: 14,    width: 17,    position: { x: 0, y: 0 },}

In the following example, the single-score component, which is a simple data type visualization, is used to show a single count metric.

JavaScript
{    component: 'single-score',    componentProps: {        dataSources: [            {                label: 'Incident',                sourceType: 'table',                tableOrViewName: 'incident',                filterQuery: '',                id: 'data_source_1',            },        ],        headerTitle: 'Open Incidents',        metrics: [            {                dataSource: 'data_source_1',                id: 'metric_1',                aggregateFunction: 'COUNT',                axisId: 'primary',            },        ]    },    height: 14,    width: 14,    position: { x: 0, y: 0 },}

permissions array

Define permissions [par_dashboard_permission] to read, edit, and share a dashboard.

At least one of the user, group, or role properties must be specified for each permission in the array.

Name

Type

Description

$id

String or Number

Required. A unique ID for the metadata object. When you build the application, this ID is hashed into a unique sys_id. For more information, see ServiceNow Fluent language constructs.Format: Now.ID['String' or Number]

user

Reference or String

The variable identifier or sys_id of a user [sys_user] to which to grant permissions. To define a user, use the Record API - ServiceNow Fluent.

group

Reference or String

The variable identifier or sys_id of a user group [sys_user_group] to which to grant permissions. To define a user, use the Record API - ServiceNow Fluent.

role

Reference or String

The variable identifier or sys_id of a role [sys_user_role] to which to grant permissions. To define a user, use the Role API - ServiceNow Fluent.

canRead

Boolean

Flag that indicates whether the user, group, or role can view the dashboard.Default: true

canWrite

Boolean

Flag that indicates whether the user, group, or role can edit the dashboard.Default: false

canShare

Boolean

Flag that indicates whether the user, group, or role can share the dashboard.Default: false

owner

Boolean

Flag that indicates whether the user, group, or role is the owner of the dashboard. For at least one user, the owner property should be set to true.Default: false
```javascript permissions: [ { $id: Now.ID['manager-user-permission'], user: 'a8f98bb0eb32010045e1a5115206fe3a', // sys_id of manager user canRead: true, canWrite: true, owner: true, }, { $id: Now.ID['itil-role-permission'], role: '2831a114c611228501d4ea6c309d626d', // sys_id of itil role canRead: true, canWrite: false, }, { $id: Now.ID['support-group-permission'], group: 'd625dccec0a8016700a222a0f7900d06', // sys_id of Service Desk group canRead: true, canWrite: false, } ] ```

visibilities array

Define visibility rules [par_dashboard_visibility] for which UX experiences display the dashboard.

Name

Type

Description

$id

String or Number

Required. A unique ID for the metadata object. When you build the application, this ID is hashed into a unique sys_id. For more information, see ServiceNow Fluent language constructs.Format: Now.ID['String' or Number]

experience

Reference or String

Required. The variable identifier of a Workspace object or sys_id of a UX application [sys_ux_page_registry]. For more information, see Workspace API - ServiceNow Fluent.
```javascript visibilities: [ { $id: Now.ID["dashboard_visibility_1"], experience: myWorkspace // Reference to Workspace object } ] ```
Keywords servicenow fluentfluent apiservicenow fluentfluent apiservicenow fluentfluent apiservicenow fluentfluent apiservicenow fluentfluent apiservicenow fluentfluent apiservicenow fluentfluent api
Search documentation
Search document titles and file paths on the australia branch