Suggest

Reference for the suggest endpoints of the Interact REST API.

Note: All endpoints require authentication and an X-Tenant header. See Authentication overview and How to get API information. Paths are relative to your intranet's API base URL. An Access line appears where an endpoint needs more than a signed-in user.

Endpoints on this page

GET /api/suggest/content
GET /api/suggest/endorsements
GET /api/suggest/expertise
GET /api/suggest/most-viewed-content

GET /api/suggest/content

Get suggested content for the current user.

Parameters

Name	In	Type	Required	Description
`limit`	query	integer (int32)	No
`offset`	query	integer (int32)	No

Responses

Status	Body
200	See below

Response body

[
  {
    "ContentId": 0,
    "AvatarId": 0,
    "ContentType": "string",
    "Title": "string",
    "Summary": "string",
    "Reason": "string",
    "Author": "string",
    "Date": "2024-01-01T00:00:00Z",
    "Url": "string",
    "LikeCount": 0,
    "ShareCount": 0
  }
]

Field	Type
`ContentId`	integer (int32)
`AvatarId`	integer (int32)
`ContentType`	string
`Title`	string
`Summary`	string
`Reason`	string
`Author`	string
`Date`	string (date-time)
`Url`	string
`LikeCount`	integer (int32)
`ShareCount`	integer (int32)

GET /api/suggest/endorsements

Get suggested endorsements for the current user.

Parameters

Name	In	Type	Required	Description
`personId`	query	integer (int32)	No
`limit`	query	integer (int32)	No

Responses

Status	Body
200	See below

Response body

{
  "Endorsee": {
    "Id": 0,
    "AssetId": 0,
    "FirstName": "string",
    "LastName": "string",
    "FullName": "string",
    "JobTitle": "string"
  },
  "Skills": [
    {
      "Id": 0,
      "Title": "string"
    }
  ]
}

Field	Type
`Endorsee`	object
`Skills`	array of object

GET /api/suggest/expertise

Get suggested expertise for the current user.

Parameters

Name	In	Type	Required	Description
`reason`	query	string	No
`limit`	query	integer (int32)	No

Responses

Status	Body
200	See below

Response body

{
  "AssetId": 0,
  "PersonId": 0,
  "Reason": {
    "Type": "string",
    "Data": "string"
  },
  "Skills": [
    {
      "Id": 0,
      "Title": "string"
    }
  ]
}

Field	Type
`AssetId`	integer (int32)
`PersonId`	integer (int32)
`Reason`	object
`Skills`	array of object

GET /api/suggest/most-viewed-content

List most viewed contents.

Parameters

Name	In	Type	Required	Description
`limit`	query	integer (int32)	No

Responses

Status	Body
200	object

Section: REST API