Recommendations

As the name suggests, recommendations are a core part of Concured Recommendations AI — the very reason Concured exists is so you can securely retrieve AI recommendations for users of your site. On this page, we'll dive into the recommendation endpoint that you can use to retrieve re commendations programmatically.

The recommendations model

The recommendation model contains the information necessary to generate a list of recommendations for a user based on the current URL. It contains information such as content title, summary, associated images, and the URL of the content.

Properties

Name
client_id
Type
string
Description
Unique identifier for the requesting client.
Name
user_id
Type
string
Description
Unique identifier for the user.
Name
session_id
Type
string
Description
Unique identifier for the user's session.
Name
current_url
Type
string
Description
The current URL the recommendation is being requested from.
Name
referrer_url
Type
string
Description
The referrer URL for the current URL.
Name
recommendation_content
Type
array
Description
An array of recommendations content.
Name
title
Type
string
Description
Title of the recommendation content.
Name
text
Type
string
Description
Summary text of the recommendation content.
Name
date
Type
timestamp
Description
Timestamp of when the recommendation content was created.
Name
images
Type
array
Description
An array of images associated with the recommendation. Includes title, url, and an optimised image url.
Name
url
Type
string
Description
URL of the recommendation content.

POST/v1/recommendations

Retrieve recommendations

This endpoint allows you to retrieve recommendations for a given URL.

Required attributes

Name
client_id
Type
string
Description
Unique identifier for the requesting client.
Name
current_url
Type
string
Description
The current URL the recommendation is being requested from.

Optional attributes

Name
user_id
Type
string
Description
Unique identifier for the user.
Name
session_id
Type
string
Description
Unique identifier for the user's session.

Request

POST

/v1/recommendations

  curl --location 'https://api.concured.com/v1/recommendations' \
  --header 'x-api-key: {api_key}' \
  --header 'Content-Type: application/json' \
  --data '{
      "client_id": "{client_id}",
      "user_id": "{user_id}",
      "session_id": "{session_id}",
      "current_url": "{current_url}"
  }'

Response

{
  "client_id": "{client_id}",
  "user_id": "{user_id}",
  "session_id": "{session_id}",
  "current_url": "https://concured.com/blog/how-to-prepare-for-the-ai-content-generation-boom",
  "referrer_url": "",
  "recommendation_content": [
      {
        "title": "Data Analytics Insights",
        "text": "For many clever content marketers, the dream is to have your content commented on, shared, and sprea",
        "date": "2023-05-24T05:01:12.113000",
        "images": [{
            "title": null,
            "url": "https://concured.com/wp-content/uploads/2022/10/Photo20editor20looking20at20multi20colored20sticky20notes20on20glass20in20meeting20room20at20creative20office.jpeg",
            "small": "https://static.concured.com/images/optimised/Concured/646d9a23b4ba6ba740586d17_0%28c_thumb%2Cg_auto%2Ch_450%2Cw_650%29.jpg"
          }],
        "base_url": "https://concured.com/blog/3/",
        "url": "https://concured.com/blog/3/"
      },
      {
        "title": "What is Content Personalization?",
        "text": "This article is the first in our series of posts focusing on content personalization: What is it, wh",
        "date": "2022-10-11T07:20:49",
        "images": [{
            "title": null,
            "url": "https://concured.com/wp-content/uploads/2022/11/page-bg-vector-green.png",
            "small": "https://static.concured.com/images/optimised/Concured/642a809a11b527dd4a312c8d_0%28c_thumb%2Cg_auto%2Ch_450%2Cw_650%29.jpg"
          }],
        "base_url": "https://concured.com/blog/what-is-content-personalization",
        "url": "https://concured.com/blog/what-is-content-personalization"
      },
      {
        "title": "Effective Ways To Seamlessly Pivot Your Brand Marketing",
        "text": "Times change – and sometimes your brand needs to change in sync. The biggest news story of a generat",
        "date": "2023-05-24T05:03:08.594000",
        "images": [{
            "title": null,
            "url": "https://concured.com/wp-content/uploads/2022/10/training-3185170_1920.jpg",
            "small": "https://static.concured.com/images/optimised/Concured/646d9ceb82a05a63e9117fa6_0%28c_thumb%2Cg_auto%2Ch_450%2Cw_650%29.jpg"
          }],
        "base_url": "https://concured.com/blog/29/",
        "url": "https://concured.com/blog/29/"
      }
  ]
}