Dashboard Component Snapshot Resource

Use this resource to post a snapshot of a dashboard component to a user, group, or dashboard feed to help other users follow changes in the data.

Resource

1/connect/dashboards/components/componentId/snapshots

Available since version

25.0

Requires Chatter

Yes

HTTP methods

POST

Request body

Root XML tag

<dashboardComponentSnapshot>

JSON

1{ 
2   "parentId" : "0F9D00000000I4O",
3   "feedItemBody" : {
4      "messageSegments" : [
5      {
6         "text" : "Sales Heat",
7         "type" : "Text"
8      }
9      ]
10   }
11}

Properties

Name	Type	Description	Available Version
parentId	String	A user, group, or dashboard ID to which you are posting the snapshot.	25.0
filterId1	String	Optional. A dashboard filter item ID.	25.0
filterId2	String	Optional. A second dashboard filter item ID.	25.0
filterId3	String	Optional. A third dashboard filter item ID.	25.0
feedItemBody	Message Body Input	Contains the text that accompanies the feed item associated with the dashboard component snapshot.	25.0
runningUserId	String	Optional. A user ID from which the view of the dashboard will be created, if other than the creator.	25.0

Request parameters

Name	Type	Description
parentId	String	A user, group, or dashboard Id to which you are posting the snapshot.
filterId1	String.	Optional. A dashboard filter item Id.
filterId2	String	Optional. A second dashboard filter item Id.
filterId3	String	Optional. A third dashboard filter item Id.
feedItemText	String	Text that accompanies the dashboard component snapshot.
runningUserId	String	Optional. A user Id from which the view of the dashboard will be created, if other than the creator.

Response body

API versions 23.0-31.0 return: Feed Item Attachment: Dashboard

API versions 32.0 and later return: Dashboard Component Snapshot