LYlytics
Content

Content Recommendation

get/api/content/recommend/user/{fieldname}/{fieldval}

Request

  • Base URL
    https://api.lytics.io
  • URL
    https://api.lytics.io/api/content/recommend/user/{fieldname}/{fieldval}
  • Auth
    API key in header Authorization

Path parameters

fieldnamestring required

field to use to identify a user

fieldvalstring required

unique identity

Query parameters

account_idstring

Your Lytics account ID.

contentsegmentstring required

id, or slug of a content-collection to filter content

limitstring

limit on number of documents to suggest/return

shuffleboolean

whether or not to shuffle the recommendation order

visitedboolean

whether to show recommendations for content the user has already viewed

topicsstring

if supplied, only allow recommendations on content with the specified topics

rankstring

Ranking method for order of recommendations. Must be one of "popular", "recent", or "affinity"

waitboolean

Whether or not to wait for more complex user identities to resolve

emailstring

if the fieldname and fieldval are omitted, an email can be provided. This can be helpful for templating use-cases

urlstring

if url is provided, the recommendations will be based on the content topics associated with the provided URL

Response

OK

messagestring
statusnumber

Example response

{
  "data": [
    {
      "url": "www.getlytics.com/blog/post/intent_through_content",
      "title": "Understanding User Intent Through Content",
      "description": "Customer Intent comes from understanding the connection between engagement and its contexts. Content modeling and affinity graphs makes interpretation of intent a lot easier. Learn how marketers can benefit from this.",
      "topics": [
        "customer data platform",
        "data science",
        "content marketing",
        "personalization"
      ],
      "topic_relevances": {
        "content marketing": 1,
        "customer data platform": 1,
        "data science": 1,
        "personalization": 1
      },
      "primary_image": "https://www.getlytics.com/img/blog/posts/intent_through_content/intent_through_content-bg.gif",
      "author": "",
      "created": "2016-06-08T16:11:45.599594093Z",
      "id": "-3435113786560588929",
      "sitename": "Lytics",
      "stream": "default",
      "path": [
        "blog",
        "blog/post",
        "blog/post/intent_through_content"
      ],
      "aspects": [
        "article"
      ],
      "language": "unknown",
      "updated": "2016-06-09T12:49:36.870359765Z",
      "fetched": "2016-06-09T12:49:35.812654441Z",
      "meta": [
        "og:locale/en_us",
        "og:site_name/lytics",
        "og:title/understanding user intent through content",
        "og:type/article",
        "og:url/https://www.getlytics.com/blog/post/intent_through_content"
      ],
      "confidence": 0.5916079783099615,
      "visited": true
    }
  ],
  "message": "success",
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.