User Recommendations for a Specific Action

Returns the recommendations for the specified action for the context user.

Resource

userId must be the ID of the context user or the alias me.

Note

Valid values for action and resulting recommendations:

follow returns recommendations to follow users, files, and records.
join returns recommendations to join groups.
view returns recommendations to view users, files, groups, and records (version 25.0 and later). In version 34.0 and later, view returns custom recommendations. In version 35.0 and later, view returns static recommendations.

Available since version

24.0

Requires Chatter

Yes

HTTP methods

GET or HEAD

Request parameters for GET

Parameter Name	Type	Description	Available Version
`contextAction`	String	Action that the user just performed. Supported values are: `follow` `view` Use `contextAction` and `contextObjectId` together to get new recommendations based on the action just performed.	33.0
`contextObjectId`	String	ID of the object that the user just perfomed an action on. If `contextAction` is `follow`, `contextObjectId` is user ID, file ID, or record ID. If `contextAction` is `view`, `contextObjectId` is user ID, file ID, group ID, or record ID. Use `contextAction` and `contextObjectId` together to get new recommendations based on the action just performed.	33.0
`followed`	String	ID of a user. Provides new recommendations based on the context of this user ID. Use `contextAction` and `contextObjectId` in version 33.0 and later. Important	23.0–32.0
`maxResults`	Integer	Maximum number of recommendation results; default is 10. Value must be greater than 0.	23.0
`viewed`	String	ID of a file. Provides new recommendations based on the context of this file ID. Use `contextAction` and `contextObjectId` in version 33.0 and later. Important	23.0–33.0

Response body

Recommendations

Chatter REST API Developer's Guide