Newer Version Available

This content describes an older version of this product. View Latest

User Recommendations for a Specific Action and Object Category

Returns the recommendations of the specified action and object category for the logged-in user. Also used to delete recommendations.

Resource
1/chatter/users/me/recommendations/action/objectCategory 
or
1/chatter/users/userId/recommendations/action/objectCategory 

userId must be the ID of the logged-in user or the alias me.

Note

  • Valid values for action:
    • follow
    • join
    • view (Available in versions 25.0 and later.)
  • Valid values for object category:
    • If action is follow, object category is users, files, or records.
    • If action is join, object category is groups.
    • If action is view, object category is users, files, groups, or records.
Available since version
23.0
HTTP methods
GET, DELETE, or HEAD
DELETE is available as of version 24.0. DELETE is used to remove a recommendation and is only valid for the following resources:
  • /chatter/users/me | userId/recommendations/follow/recommendedUserId
  • /chatter/users/me | userId/recommendations/follow/recommendedFileId
  • /chatter/users/me | userId/recommendations/follow/recommendedRecordId
  • /chatter/users/me | userId/recommendations/join/recommendedGroupId

userId must be the ID of the logged-in user or the alias me.

Note

Request parameters for GET or HEAD
Parameter Name Type Description Since Version
maxResults Integer Maximum number of recommendation results; default is 10. Value must be greater than 0. 23.0
followed String ID of a user. Provides new recommendations based on the context of this user ID. 24.0
viewed String ID of a file. Provides new recommendations based on the context of this file ID. 25.0
Example request URL with followed request parameter
1/chatter/users/me/recommendations/follow/users?followed=005D0000001GLowIAB
Response body for GET with followed request parameter
Zero or one user Recommendation response
Example request URL with viewed request parameter
This URL provides a list of files viewed by the same people who have viewed the file you’re viewing. This is also the same value displayed in the People Also Viewed area on the file detail page for the given ID.
1/chatter/users/me/recommendations/view/files?viewed=069D00000000xNXIAY
Response body for GET with viewed request parameter
Zero or more file Recommendation responses
Response body for GET or HEAD without request parameters
Zero or more Recommendation responses
Response body for DELETE
204: Successful Delete