Chatter REST API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

Topics Suggestions

List of suggested topics for a specified string of text, feed item, or record.
Resource
1/connect/topics/suggestions
Available since version
29.0

In version 28.0, use /chatter/topics/suggestions.

HTTP methods
GET or HEAD
Request parameters
Parameter Name Values Description Required or Optional
maxResults Integer Maximum number of topic suggestions that get returned. The default is 5. Value must be greater than 0 and less than or equal to 25. Optional
recordId String 18-character ID of a feed item or record from which to extract topics. Administrators must enable topics for objects to see topic suggestions for records of that object type. Topics for objects is available in version 30.0. Required if the text parameter isn’t used
text String Text from which to extract topics. Required if the recordId parameter isn’t used
Response body
Topic Suggestion Collection
Example for GET
This example gets topic suggestions for the text “Working on the planning meeting for our new initiative.”
1/connect/topics/suggestions?text=Working+on+the+planning+meeting+for+our+new+initiative.

The following is the response body:

1{"topicSuggestions" : [
2   {
3      "existingTopic" : 
4      {
5         "createdDate": "2013-01-01T20:43:31.000Z",
6         "description" : "Our new initiative for hiring in 2013."
7         "id" : "0TOD0000000099dOAA"
8         "talkingAbout" : 5,
9         "name" : "New initiative",
10         "url": "/services/data/v30.0/connect/topics/0TOD0000000099dOAA"
11      }
12      "name" : "New initiative"
13   },
14   {
15      "existingTopic" : 
16      {
17         "createdDate": "2012-11-14T05:24:23.000Z",
18         "description" : "One place to keep track of all of our planning meetings across all of our initiatives."
19         "id" : "0TOD0000000099eOAA"
20         "talkingAbout" : 28,
21         "name" : "planning meeting",
22         "url": "/services/data/v30.0/connect/topics/0TOD0000000099eOAA"
23      }
24      "name" : "planning meeting"
25   },
26   {
27      "existingTopic" : null
28      "name" : "New"
29   },
30   {
31      "existingTopic" : null
32      "name" : "Initiative"
33   },
34]}