User Recommendations for a Specific Action and Key Prefix

Returns the recommendations for the specified action and key prefix for the context user.

Resource

1/chatter/users/userId/recommendations/action/idPrefix

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

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

Note

Valid values for action:
- follow
- join
- view
The key prefix, or idPrefix in the resource URL, is the first three characters of the object ID and indicates the object type. Valid values for idPrefix in this URL are:
- If action is follow, idPrefix is the key prefix for users (005), files (069), topics (0TO), or records (such as 001 or 003).
- If action is join, idPrefix is the key prefix for groups (0F9).
- If action is view, idPrefix is the key prefix for users (005), files (069), groups (0F9), records (such as 001 or 003), custom recommendations (0RD) in version 34.0 and later, static recommendations (T) in version 35.0 and later, or articles (such as kA0) in version 37.0 and later.

Available since version

26.0

Requires Chatter

Yes

HTTP methods

GET or 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

Example request URL

1/chatter/users/me/recommendations/view/001

Response body for GET

Recommendations

Chatter REST API Developer Guide

User Recommendations for a Specific Action and Key Prefix