Chatter REST API Developer's Guide

Introducing Chatter REST API
Chatter REST API Quick Start
Chatter REST API Features
Chatter REST API Examples
Chatter REST API Resources
Action Links Resources
Announcements Resource
Async Query Resources
Batch Resource
Chatter Resource
Comments Resources
Communities Resources
Communities Moderation Resources
Connect Resources
Dashboard Component Snapshot Resource
Datacloud Resources
Feed Elements Resources
Feed Items Resources
Feeds Resources
Files Connect Repository Resources
Files Resources
Folders Resources
Groups Resources
Influence Resource
Likes Resource
Managed Topics Resources
Mentions Resources
Motifs Resources
Push Notifications Resource
Question and Answers Suggestions Resource
Recommendation Audience Resources
Recommendation Definition Resources
Records Resources
Scheduled Recommendations Resources
Subscriptions Resource
Topics Resources
User Profiles Resources
Users Resources
User Information
User Profile Information
Batch User Information
User Conversations, General
User Conversations, Specific
Change Status of Conversations
Get Unread Count for Conversations
Users Files, General
User Files, Filtered by Group
User Files, Filtered by Sharing
User Followers
Following
User Groups
Topics a User is Knowledgeable About
User Messages, General
User Messages, Specific
User Photo
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
User Status
Topics Recently Used
Zones Resources
Chatter REST API Request Bodies
Chatter REST API Response Bodies
Chatter REST API Appendices
PDF

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 for the specified action and object category for the context user.
Resource

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, or records.
    • If action is join, objectCategory is groups.
    • If action is view, objectCategory is users, files, groups, records, custom (version 34.0 and later), or apps (version 35.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
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 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:
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.
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.