SMsmartsheet
dashboards

Get dashboard publish status

Gets the dashboard 'publish' settings.

get/sights/{sightId}/publish

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

Response

SightPublish object

readOnlyFullAccessibleBy'ALL' | 'ORG'

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).

readOnlyFullEnabledboolean required

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

readOnlyFullUrlstring

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

Changes

No recorded changes to this operation across all 16 revisions of this API.