Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Chatter Resources
Announcements Resources
Chatter Resources
Comments Resources
Custom Recommendation Audience Resources
Custom Recommendation Definition Resources
Dashboard Component Snapshot Resource
Experience Cloud Sites Chatter Moderation Resources
Feed Elements Resources
Feeds Resources
Followers on Records Resource
Groups Resources
Influence Resource
Likes Resource
Mentions Resources
Missions Resources
Question and Answers Resources
Scheduled Custom Recommendations Resources
Subscriptions Notifications Member Resource
Subscriptions Resource
Topics Resources
User Profiles Resources
Users Resources
User Information
User Profile Information
Batch User Information
User Activity, Export
User Activity, Purge
User Conversations, General
User Conversations, Specific
Get Unread Count for Conversations
User Followers
Following
User Groups
Topics a User Is Knowledgeable About
Topics a User Is Knowledgeable About: Batch Users
User Messages, General
User Messages, Specific
User Recommendations, General
User Recommendations for a Specific Action
User Recommendations for a Specific Action and Object Category
User Recommendations for a Specific Action and Key Prefix
User Recommendations for a Specific Action and Object ID
User Recommendations for a Specific Action and Object Type
User Reputation
User Settings
Topics Recently Used
Request Bodies
Response Bodies
Appendices
PDF

Newer Version Available

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

User Recommendations, General

Get the Chatter recommendations, such as user, group, file, record, topic, and article recommendations, for the context user. Also get custom and static recommendations for the context user.
Resource

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

Note

Available since version
24.0
Requires Chatter
Yes
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Available Version
channel String A way to tie custom recommendations together. For example, display recommendations in specific places in the UI or 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 Experience 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 Home and Question Detail pages of Customer Service and Partner Central Experience Builder templates. They also appear in the feed in the Salesforce mobile web and anywhere community managers add recommendations using Experience Builder.
 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
Chatter Recommendations