SMsmartsheet
dashboards

Get Dashboard

Changed on

Gets the specified dashboard.

get/sights/{sightId}

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: READ_SIGHTS

Query parameters

accessApiLevelnumber

Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1.

include'objectValue' | 'source'

A comma-separated list of optional elements to include in the response:

  • objectValue - when used in combination with a level query parameter, includes the email addresses for multi-contact data.
  • source - the Source object for any Sight that was created from another Sight, if any
levelinteger

Specifies whether new functionality, such as multi-contact data is returned in a backwards-compatible, text format (level=0, default), multi-contact data (level=2), multi-picklist data (level=3), or Metric widget with sheet summary (level=4).

numericDatesboolean

You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request.

Response

Dashboard object

namestring

Dashboard name.

Changes

  • 5fecdbbecd34Revision changes
    • info

      the response optional property /////// became write-only for the status

    • info

      the response optional property /////// became write-only for the status

  • 636ac6da2c11Revision changes
    • info

      added the optional property to the response with the status