Smartsheet logo

Objects

Dashboard Object

backgroundColor
string

The hex color, for instance #E6F5FE.

defaultWidgetBackgroundColor
string

The hex color of the background color for all widgets except for title widgets on the dashboard, for instance #E6F5FEF4 or #E6F5FE.

columnCount
number

Number of columns that the dashboard contains.

favorite
boolean

(Deprecated) Indicates whether the user has marked the dashboard as a favorite.

object
Array of objects
object

Can contain dashboards, folders, reports, sheets, and templates.

string or number
string or number
id
number

Dashboard Id.

accessLevel
string
Enum: "ADMIN" "COMMENTER" "EDITOR" "EDITOR_SHARE" "OWNER" "VIEWER"
permalink
string

URL that represents a direct link to the dashboard in Smartsheet.

name
string

Dashboard name.

{
  • "backgroundColor": "string",
  • "defaultWidgetBackgroundColor": "string",
  • "columnCount": 0,
  • "favorite": true,
  • "source": {
    },
  • "widgets": [
    ],
  • "workspace": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "accessLevel": "ADMIN",
  • "permalink": "string",
  • "name": "string"
}

DashboardPublish Object

readOnlyFullAccessibleBy
string

Indicates who can access the 'Read-Only Full' view of the published dashboard. Only returned in the response if readOnlyFullEnabled = true.

  • ALL - available to anyone who has the link.
  • ORG - available only to members of the dashboard owner's Smartsheet organization account.
  • SHARED - available only to users shared to the item.

If readOnlyFullEnabled is set to true in the request, but readOnlyFullAccessibleBy is not specified, the value of readOnlyFullAccessibleBy defaults to the organization-level 'Dashboard Publishing' setting (if the dashboard owner belongs to an organization account) or to ALL (if the dashboard owner does not belong to an organization account).

Enum: "ALL" "ORG"
readOnlyFullEnabled
required
boolean

If true, a rich version of the dashboard is published with the ability to use shortcuts and widget interactions.

readOnlyFullUrl
string

URL for 'Read-Only Full' view of the published dashboard. Only returned in a response if readOnlyFullEnabled = true.

{
  • "readOnlyFullAccessibleBy": "ALL",
  • "readOnlyFullEnabled": true,
  • "readOnlyFullUrl": "string"
}

Widget Object

id
number

Widget Id.

type
string

Type of widget.

Enum: "CHART" "GRIDGANTT" "IMAGE" "METRIC" "RICHTEXT" "SHEETSUMMARY" "SHORTCUT" "SHORTCUTICON" "SHORTCUTLIST" "TITLE" "WEBCONTENT"
Chart (object) or Metric (object) or Image (object) or Report (object) or Rich Text (object) or Shortcut (object) or Title (object) or Web Content (object)

The type of widget content depends on the value of widget.type.

height
number

Number of rows that the widget occupies on the dashboard.

showTitle
boolean

True indicates that the client should display the widget title. This is independent of the title string which may be null or empty.

showTitleIcon
boolean

True indicates that the client should display the sheet icon in the widget title.

title
string

Title of the widget.

titleFormat
string

Title format descriptor (see Formatting).

titleFont
string

List of supported fonts in Dashboards

Enum: "Arial" "Courier" "Georgia" "Gill Sans" "Helvetica" "Luminari" "Monaco" "Tahoma" "Times New Roman" "Verdana"
version
number

Widget version number.

viewMode
number

Indicates the content layout. Must use a query parameter of level=2 to see this information.

  • 1 - centered
  • 2 - left aligned
Enum: 1 2
width
number

Number of columns that the widget occupies on the dashboard.

xPosition
number

X-coordinate of widget's position on the dashboard.

yPosition
number

Y-coordinate of widget's position on the dashboard.

{
  • "id": 0,
  • "type": "CHART",
  • "contents": {
    },
  • "height": 0,
  • "showTitle": true,
  • "showTitleIcon": true,
  • "title": "string",
  • "titleFormat": ",,1,,,,,,,3,,,,,,1,",
  • "titleFont": "Arial",
  • "version": 0,
  • "viewMode": 1,
  • "width": 0,
  • "xPosition": 0,
  • "yPosition": 0
}

CellLinkWidgetContent Object

type
string
Enum: "METRIC" "SHEETSUMMARY"
sheetId
number

Sheet Id from which the cell data originates.

Array of objects
Array of objects
object
{
  • "type": "METRIC",
  • "sheetId": 0,
  • "cellData": [
    ],
  • "columns": [
    ],
  • "hyperlink": {
    }
}

CellDataItem Object

columnId
number

Column Id for each item.

rowId
number

Row Id for each item.

sheetId
number

Sheet Id for each item.

boolean or number or string

The type of data returned depends on the cell type and the data in the cell.

object
dataSource
string
Enum: "CELL" "SUMMARY_FIELD"
inheritCellValue
boolean

Specifies if valueFormat is inherited from the underlying cell value

label
string

Label for the data point. This is either the column name or a user-provided string.

labelFormat
string

Format description for label.

labelFont
string

List of supported fonts in Dashboards

Enum: "Arial" "Courier" "Georgia" "Gill Sans" "Helvetica" "Luminari" "Monaco" "Tahoma" "Times New Roman" "Verdana"
order
number

The display order for the CellDataItem.

object
valueFormat
string

Format description for value.

valueFont
string

List of supported fonts in Dashboards

Enum: "Arial" "Courier" "Georgia" "Gill Sans" "Helvetica" "Luminari" "Monaco" "Tahoma" "Times New Roman" "Verdana"
{
  • "columnId": 0,
  • "rowId": 0,
  • "sheetId": 0,
  • "objectValue": true,
  • "cell": {
    },
  • "dataSource": "CELL",
  • "inheritCellValue": true,
  • "label": "string",
  • "labelFormat": ",,1,1,,,,,,,,,,,,,",
  • "labelFont": "Arial",
  • "order": 0,
  • "profileField": {
    },
  • "valueFormat": ",,1,1,,,,,,,,,,,,,",
  • "valueFont": "Arial"
}

ChartWidgetContent Object

type
string
Value: "CHART"
reportId
number

Report Id denoting container source, if applicable.

sheetId
number

Sheet Id denoting container source, if applicable.

Array of objects
object
includedColumnIds
Array of numbers

Array of column Ids if the range was selected through the UI.

object
Array of objects
Array of objects
object
object
{
  • "type": "CHART",
  • "reportId": 0,
  • "sheetId": 0,
  • "axes": [
    ],
  • "hyperlink": {
    },
  • "includedColumnIds": [
    ],
  • "legend": {
    },
  • "selectionRanges": [
    ],
  • "series": [
    ],
  • "verticalGridLines": {
    },
  • "horizontalGridLines": {
    }
}

ImageWidgetContent Object

type
string
Value: "IMAGE"
privateId
string

The image private Id.

fileName
string

Name of the image file.

fit
string

Describes how the image occupies the available space of its widget.

  • ACTUAL_SIZE - Uses the original image width and height dimensions.
  • FILL - Scales the image to maintain its aspect ratio while filling its entire widget. If the image aspect ratio does not match the aspect ratio of its widget, then the image will be clipped to fit.
  • FIT - Scales the image to maintain its aspect ratio while fitting within its widget. The image will be "letterboxed" if its aspect ratio does not match the aspect ratio of its widget. Default value for new image widgets and for existing image widgets where this property has not been explicitly set.
Enum: "ACTUAL_SIZE" "FILL" "FIT"
format
string

Format descriptor. Follows the pattern in FormatTables.

height
number
object
margin
string

Indicates whether there is margin between the image and its widget borders.

  • MARGIN - Default value for existing image widgets where this property has not been explicitly set.
  • NO_MARGIN - Default value for new image widgets.
Enum: "MARGIN" "NO_MARGIN"
width
number

Original width of the image in pixels.

{
  • "type": "IMAGE",
  • "privateId": "string",
  • "fileName": "string",
  • "fit": "ACTUAL_SIZE",
  • "format": ",7,1,,,,2,2,1,3,,,,,,1,",
  • "height": 0,
  • "hyperlink": {
    },
  • "margin": "MARGIN",
  • "width": 0
}

ReportWidgetContent Object

type
string
Value: "GRIDGANTT"
reportId
number

Report Id denoting container source.

htmlContent
string

HTMl snippet to render report.

backgroundColor
string

The hex color.

object
{
  • "type": "GRIDGANTT",
  • "reportId": 0,
  • "htmlContent": "string",
  • "backgroundColor": "#E6F5FE",
  • "hyperlink": {
    }
}

RichTextWidgetContent Object

type
string
Value: "RICHTEXT"
htmlContent
string

The widget contents as HTML. The Rich Text widget supports the following subset of HTML tags and CSS Styles:

HTML

  • a - hyperlink
  • br - line break
  • li - list item
  • ol - ordered list
  • p - paragraph
  • span - section of the document
  • ul - unordered list

CSS

  • color
  • font-family
  • font-size
  • font-style
  • font-weight
  • text-align
  • text-decoration
{
  • "type": "RICHTEXT",
  • "htmlContent": "string"
}

SelectionRange Object

sourceColumnId1
number

Defines beginning edge of range when specifying one or more columns.

sourceColumnId2
number

Defines ending edge of range when specifying one or more columns.

sourceRowId1
number

Defines beginning edge of range when specifying one or more rows.

sourceRowId2
number

Defines ending edge of range when specifying one or more rows.

{
  • "sourceColumnId1": 0,
  • "sourceColumnId2": 0,
  • "sourceRowId1": 0,
  • "sourceRowId2": 0
}

ShortcutDataItem Object

attachmentType
string
Enum: "BOX_COM" "DROPBOX" "EGNYTE" "EVERNOTE" "FILE" "GOOGLE_DRIVE" "LINK" "ONEDRIVE" "SMARTSHEET"
object
label
string

Label for the data point.

labelFormat
string

Format description of label.

labelFont
string

List of supported fonts in Dashboards

Enum: "Arial" "Courier" "Georgia" "Gill Sans" "Helvetica" "Luminari" "Monaco" "Tahoma" "Times New Roman" "Verdana"
mimeType
string
order
number

The display order for the ShortcutWidgetItem object.

{
  • "attachmentType": "BOX_COM",
  • "hyperlink": {
    },
  • "label": "string",
  • "labelFormat": ",,1,1,,,,,,,,,,,,,",
  • "labelFont": "Arial",
  • "mimeType": "string",
  • "order": 0
}

ShortcutWidgetContent Object

type
string
Enum: "SHORTCUT" "SHORTCUTICON" "SHORTCUTLIST"
Array of objects
{
  • "type": "SHORTCUT",
  • "shortcutData": [
    ]
}

TitleWidgetContent Object

type
string
Value: "RICHTEXT"
backgroundColor
string
htmlContent
string

The widget contents as HTML. The Title widget supports the following subset of HTML tags and CSS Styles:

HTML

  • br - line break
  • p - paragraph
  • span - section of the document

CSS

  • color
  • font-family
  • font-size
  • font-style
  • font-weight
  • text-align
  • text-decoration
{
  • "type": "RICHTEXT",
  • "backgroundColor": "string",
  • "htmlContent": "<p style=\"text-align:center\"><span class=\"clsDbFt\">HI!</span></p>"
}

WebContentWidgetContent Object

type
string
Value: "WidgetWebContent"
url
string

The URL for the web content.

{}
➔ Next to Methods