CreateDashboardWidgetInput

Input Object

XAxis

Field to use for X-axis

XAxisCustomFieldId

Custom field ID for X-axis

XAxisTitle

Title for X-axis

YAxis

Field to use for Y-axis

YAxisCustomFieldId

Custom field ID for Y-axis

YAxisGroupBy

A second measure shown beside YAxis; to split the data into series, use groupBy.

YAxisGroupByCustomFieldId

Custom field ID for secondary Y value when YAxisGroupBy is CustomFields

YAxisTitle

Title for Y-axis

actionCreatedDateRange

Date range filter for action creation dates

aggFunc

Aggregation function for chart values

applyFormulaTo

How formula grand totals are calculated (eachRow or total)

barChartDisplayMode

Display mode for bar charts with break-out-by: stacked or clustered

binBy

Time interval used to bucket date-based chart values

binByDateRange

Date range used as the bin window for date-based X axes

burndown

Burndown settings, read when YAxis is burndown on a Line widget

buttonDescription

Subtitle or description for button widgets (max 280 characters)

buttonHeading

Heading for call-to-action and links-style button widgets (max 120 characters)

buttonIcon

Key of a curated icon for button widgets

buttonLabel

Label for button widgets

buttonLinks

Links of a links-style button widget (max 12)

buttonLinksLayout

buttonSecondaryLabel

Label of the secondary link in call-to-action button widgets (max 120 characters)

buttonSecondaryUrl

http(s) URL or app-relative path of the secondary link in call-to-action button widgets

buttonStyle

Look of a button widget. Null renders classic.

buzzCustomPrompt

Custom prompt for Buzz AI Widget

buzzWidgetCustomPrompt

Optional custom instructions for Buzz AI Widget summaries

buzzWidgetMode

Mode for Buzz AI Widget

chartColorPalette

Ordered #RRGGBB snapshot. Takes precedence over colorThemeId; ignored below 2 colors.

chartType

Type of chart to display

chartValueColors

Color configuration for chart values

chartValuesState

Used to store the state of the chart values (colors, order, etc.)

colorThemeId

Color theme ID

completedActionsFilter

Filter for completed vs incomplete actions

completedDateRange

Date range filter for completed actions

containerId

ID of the dashboard or notebook this widget will be placed on. Must be a real id obtained from the current dashboard context provided in the conversation, or from a prior getDashboards / getNotebooks lookup. Never invent or guess this id — if no id is available, ask the user which dashboard/notebook to use.

containerType

Type of container the widget belongs to. Defaults to 'dashboard' when omitted. Set to 'notebook' only when the containerId refers to a notebook.

contentTextAlignment

Alignment of content text

contentTextColorPrimary

Primary color for content text

contentTextColorSecondary

Secondary color for content text

contentTextSize

Size of content text

createdDateRange

Date range filter for created actions

crmReportAggregation

Aggregation for CRM metric report widgets

crmReportBaseObject

Data source for CRM metric report widgets

crmReportField

Field for CRM metric report widgets when aggregation requires one

crmReportFilters

Persisted CRM report filters and display options

crmReportType

CRM report variant for CrmReport widgets

customAppAskBeforeOpen

Whether each viewer confirms before an appStudio widget's app starts. Omitted or false starts it at once.

customAppAuthoringThreadId

Your own App Studio Buzz conversation in this workspace that is building the widget's app. The tile shows its progress until the app is published.

customAppId

App Studio app to run in an appStudio widget. It must be published as a widget in this workspace.

customAppWidgetId

Id of one of the appStudio app's dashboard widgets, declared by its published version. The tile runs only that widget, read-only.

customFieldValueGroupings

dateRange

General date range filter

displayGroupsAs

How to display grouped data

dueDatesRange

Date range filter for due dates

excludeOpportunityOwners

Excluded owner IDs; null = unassigned

excludeWeekendsFromTimeToComplete

When true, Time to complete excludes Saturday/Sunday spans. Defaults to false.

externalDataConfig

External data source/config contract

externalDataTemplateId

External data template identifier

externalDataVisualizationType

External data visualization mode

fileIds

Array of file IDs associated with this widget

filter

The widget's own filters, in the same shape as a dashboard filter: projects, assignees, labels, statuses, teams, users, role, custom fields, date ranges and the rest. Every filter you set is turned on; selectedFilters is worked out for you, on top of the report's defaults (for example "exclude completed actions"; set completedActions to include completed work). Values here win over the separate filter fields above. Action list widgets reject filters they can't apply, and on them a dashboard filter set on the same key wins. Only chart, pivot, heatmap, numbers, time tracked, list (actions, my actions, risks and issues, goals), calendar, timeline, gantt, geo map, resourcing, Buzz summary and workspace activity widgets take a filter; leave it out on every other type, such as a projects list, a section header or a table. Dashboard filters still apply to the filters you don't set here. A report default (such as the time report's "This month") is skipped when the dashboard filter already sets that key, so set the dashboard filter before you create widgets that should follow it.

finishLineValue

Maximum value displayed at the finish line

fitToContent

Expand project widget content in every dashboard view. Omitted or false preserves saved sizing.

fromStatus

Start status name for Time Between Statuses (matches action.status).

goalId

ID of associated goal

goalIds

IDs of associated goals

gridLines

Grid line display option for chart

groupBy

Field to break out / group chart series by

groupByCustomFieldId

Custom field ID for grouping

groupOthers

Configuration for grouping "other" values

hideHeader

Whether to hide the widget header

ignoreContainerFilter

If true, widget ignores container-level filters

isHidden

Whether widget is hidden

isProjectTreeLevelActive

Whether project tree level is active

isTreeLevelActive

Whether tree level filtering is active

layoutX

Legacy placement inputs accepted for client compatibility and ignored.

layoutY

legendPosition

Position of the chart legend

lineAreaFillMode

lineChartDisplayMode

Display mode for line charts with time-series X axis

lineInterpolation

lineShowDataPoints

mapDataSeries

Ordered multi-source series for dashboard GeoMap widgets.

mapReportConfig

Deprecated per-report config blob for GeoMap widgets. Kept for backward compatibility; prefer mapDataSeries and mapStyle.

mapReportType

Geographic report variant for GeoMap widgets. Kept for persisted widgets.

mapStyle

Basemap: Carto Positron (normal) or Blue Marble day + Black Marble night lights (realistic).

noteId

ID of associated note

opportunityCloseDateRange

Date range filter for opportunity close dates

opportunityOwners

Opportunity owner IDs; null represents unassigned

opportunityStageOutcomes

Opportunity stage outcomes

opportunityStageStates

Opportunity stage states

overdueFilter

Filter for overdue actions

placeAtBottom

projectArchivedDateRange

Project archive date range for Time pivots; active projects follow the archived-project mode.

projectBudgetCategoryIds

Budget category IDs for project budget widgets

projectBudgetDateRange

Date range for project budget widgets

projectCreatedDateRange

Date range filter for project creation dates

projectCustomFieldsShowProjectName

Whether to show the selected project name above custom fields

projectCustomFieldsValueLayout

Whether custom field values appear below or beside field names

projectDateRange

Date range filter for project dates

projectDetailsFields

Fields to show in project details

projectDetailsInlineEditing

Whether supported project details can be edited from the widget

projectDetailsStackedLayout

Whether project detail values appear below their labels instead of beside them

projectId

ID of associated project

projectIds

IDs of accociated projects

projectStatusDateRange

Date range filter for project status dates

projectTabId

Project Page tab id when skipContainerAttachment is true. Server validates the tab is a locally-filtered Page tab linked to containerId before allowing tab-local create.

projectTreeLevelsToShow

Which levels of project tree to display

recordFilters

recurringFilter

Filter for recurring actions

reportOn

What type of data to report on

sectionHeaderLinePosition

Position of section header line

sectionHeaderText

Text for section header

sectionHeaderTextAlignment

Alignment of section header text

segmentColorOverrides

Color overrides for chart segments

showColumnTotals

Whether to show column totals

showFlattenedData

Whether to show pivot table in a data mode (flattened)

showLegend

Whether to show chart legend

showLinkedToProject

Whether to show links to related projects

showRowTotals

Whether to show row totals

showSparklineTrend

Whether to show the sparkline trend badge

showTitles

Whether to show titles in the widget

showTrendCompareLabel

Show the compare-period label (e.g. vs Aug) in the number trend row

showTrendPreviousValue

Show the previous-period value in the number trend row

showTrendSparkline

Show the sparkline in the number trend row

showValueLabels

Whether to show data point values

skipContainerAttachment

When true, creates the widget document but does not add it to the container dashboard widgetIds/layout or synced tab copies. Used for hidden dashboard drafts and linked project tabs that keep new widgets in tab-local state only.

sort

Sort order for widget data

sparklineTrendMode

Which values appear in the sparkline trend badge

stackedLabelMode

Value label mode for stacked charts (total or per segment)

tableId

Tables table backing the widget when reportOn is records

timeUnitsType

Time unit for temporal data

title

Title text to display for the widget

titleColor

Hex color code for the widget title

titleSize

Size of the title text

toStatus

End status name for Time Between Statuses (matches action.status).

treeLevelsToShow

Which levels of tree grouping to display

truncateLongNumbers

Whether to truncate long numbers

type

The type of dashboard widget to create. For count/KPI/scalar metric widgets, use pivotNumbers — not the deprecated numbers type.

url

URL for embedded content widgets

workspaceId

ID of workspace this widget belongs to

wrapColumnHeaders

Wrap column labels to at most three lines. Omitted or false keeps single-line headers.