User Recommendations for a Specific Action and Object Category

Returns the recommendations for the specified action and object category for the context user.

Resource

1/chatter/users/userId/recommendations/action/objectCategory

1/connect/communities/communityId/chatter/users/userId/recommendations/action/objectCategory

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

Note

Valid values for action:
- follow
- join
- view (version 25.0 and later)
Valid values for objectCategory:
- If action is follow, objectCategory is users, files, records, or topics (version 36.0 and later).
- If action is join, objectCategory is groups.
- If action is view, objectCategory is users, files, groups, records, custom (version 34.0 and later), apps (version 35.0 and later), or articles (version 37.0 and later).

Available since version

23.0

Requires Chatter

Yes

HTTP methods

GET, HEAD

Request parameters for GET

Parameter Name	Type	Description	Available Version
`channel`	String	Specifies a way to tie recommendations together, for example, to display recommendations in specific places in the UI or to show recommendations based on time of day or geographic locations. Values are: `CustomChannel1`—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. For example, community managers can use Community Builder to determine where recommendations appear. `CustomChannel2`—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. `CustomChannel3`—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. `CustomChannel4`—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. `CustomChannel5`—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. `DefaultChannel`—Default recommendation channel. Recommendations appear by default on the Napili community home and question detail pages and in the feed in communities in the Salesforce1 mobile browser app. They also appear anywhere community managers add recommendations using Community Builder in communities using the Summer ’15 or later version of the Napili template.	36.0
`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 performed an action on. If `contextAction` is `follow`, `contextObjectId` is user ID, file ID, record ID, or topic ID (version 36.0 and later). If `contextAction` is `view`, `contextObjectId` is user ID, file ID, group ID, record ID, or article ID (version 37.0 and later). 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. Values must be from 1 to 99.	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 for GET

Recommendations

Example request URL to get new recommendations based on an action just performed

If you just followed Pam, who has a user ID of 005D0000001GLowIAB, use:

1/chatter/users/me/recommendations/follow/users?contextAction=follow&contextObjectId=005D0000001GLowIAB

to get only recommendations of users who are followed by the same people who follow Pam. In this example, John follows Pam so you get a recommendation to follow Suzanne since John also follows Suzanne. Your new recommendation to follow Suzanne.

Your new recommendation to follow Suzanne.

Example request URL to get a list of files viewed by the same people who viewed the file you’re viewing

This URL provides the same list that displays in the People Also Viewed area on the file detail page for the given file ID.

1/chatter/users/me/recommendations/view/files?contextAction=view&contextObjectId=069D00000000xNXIAY

Chatter REST API Developer Guide

User Recommendations for a Specific Action and Object Category

See Also: