Personalization Cloud: APIs

Overview

The Personalization Cloud API gives your websites and apps access to personalized content and recommendations.

To deliver links in the most efficient way possible and reduce latency, the API returns all required information in a single call. All the information needed to display the recommended products is available in the response.

Features include but are not limited to

• Full reporting via the Personalization Cloud dashboard

• Intelligent adjustment of data models based on user behavior

• Merchandising rule support (the recommendations returned by the API respect all merchandising rules set up in the dashboard)

IMPORTANT: Only call the parameters that you need. Algonomy operates off a set of APIs that support many applications and clients concurrently. Algonomy may update and enhance these APIs at any time. If you are building a mobile app, use our mobile SDKs.

Page Link	Description
catalogInfo	Returns the children of a given category down to a specified depth. To see the siblings of a category, use catalogInfo/siblings.
catalogInfo/siblings	Returns the siblings of a given category.
Catalog Update API	Enables users to send catalog update requests as catalog changes are made.
Content Update API	Enables users to send content update requests as content catalog changes are made.
doNotUse	Marks a product that should not be used for recommendations. The product will not be used as a basis for personalized recommendations.
getProducts	Returns product information for specified products.
Omnichannel Order API	Enables to import either multiple orders or a single order per API request.
Placement Report API	This API allows the user to add, verify or delete placements.
Profile API	Get user profile information for a user.
Product Trend Analytics API	Returns the Top 30 clicked, viewed and purchased products.
service/typeAhead	Get type ahead suggestions for a keyword prefix.
service/userProfile	Get user profile information for a user.
service/userProfileEventStream	A web socket interface to receive all events that are streaming into the UPS (User Profile Service). When connected, you will receive one message for each event into the UPS.
userInfo	Returns information about the user’s purchase and view history.
user/preference	Records the customer’s preferences in the Personalization Cloud. Customers can like or dislike individual products, brands, categories, and stores. Customers can also single out products that they don’t  want to see in recommendations.
user/preference{USER ID}	This is part of Customer Preference Center (CPC). It summarizes the customer's information and preferences.
User Profile Enrichment Service	Updates single or multiple user profiles simultaneously with User Attributes, User Segments, and User Linking information.

Compression

We highly recommend you use gzip compression in your HTTP request headers and response headers to ensure the best performance.

The client sends a header telling the server it accepts compressed content (gzip compression): Accept-Encoding: gzip

If the API receives the request header, the content will be compressed and the response will have a header: Content-Encoding: gzip

Prerequisites

Your Algonomy team supplies you with this information. These are required by each API call:

Item	Example	Description
API Client Key	[random character string]	Unique key specific to each API implementation. Identifies the specific application for reporting, permissions, logging and monitoring.
API Key	[random character string]	Your site’s API key, a unique identifier for your account.
Placement(s)	Home_page.mobile_splash, category_page.call_center_right	This identifies a specific area of your page or application where personalized content will be displayed. (Not required for all API endpoints, but essential for recsForPlacements.)