Intelligence - Content Recommendations

Retrieves content recommendations and engagement insights for the specified context.
The input context can be a person identified by their email, or can be a CRM record ID with the associated contextType.

Request

Get a recommendation based on the target's email address

The minimum set of required fields to get recommendations based on the target's email address is a single context item with a contextEmail field.

  "contexts": [
    {
      "contextEmail": "[email protected]"
    }
  ]

Get a recommendation based on an opportunity id

The minimum set of required fields to get recommendations based on the target's email address is a single context item with a contextEmail field.

  "contexts": [
    {
      "contextId": "0064u000012vTE4AAM",
      "contextType" : "opportunity"
    }
  ]

Response

The response is an object broken into the following parts:

  • debugInfo - this can be treated as an opaque json object and is primarily used by Seismic for issue debug
  • multiPartySummary - in the cases when a multi-party object such as an opportunity is used as the input, the consolidated recommendations and insights for the opportunity will be presented here
  • people - this is the list of people to get recommendations for. In the case of a single person request, this will be an array of 1. In the case of an opportunity or list of people, this array will have more than 1 entry. This list is intended to provide specific recommendations and insights for each person which may be different than the holisitic recommendations for the multi-party object
  • hasNewRecommendations - boolean indicating if new recommendations are available since the last time this user saw these recommendations. This is used in conjunction with the recommendationStatus endpoint (coming soon) that can indicate which recommendations the user has seen.
  • hasNewInsights - boolean indicating if new insights are available since the last time this user saw these insights. This is used in conjunction with the recommendationStatus endpoint (coming soon) that can indicate which insights the user has seen.

recommendations object

This provides the list of content being recommended for the multiParty object or individual person. Most importantly these recommendations have a single content node with the recommended content. This full content node should be used in any subsequent content actions to ensure full reporting traceability.
Each recommendation also provides the list of available deliveryOptions including their name and id.
The recommendation also provides details about the recommenders used to drive the overall result in case the recommender is desirable to use to explain to the user why the recommendation is being surfaced.

enrichedContexts object

This object supplements the person or multiParty object with additional details, typically pulled from CRM. This provides information such as the record name, opportunity stage, account industry, contact title to help display relevant information to users.

  • contact/lead fields are:
    • title
    • accountName
  • opportunity fields are:
    • accountName
    • stage
    • industry
    • amount
    • closeDate

insights object

This object supplements the person or multiParty object with additional details about the previous engagement of the people or multiParty entity.

Language
Authentication
Header
Click Try It! to start a request and see the response here!