Skip to main content
RichRelevance

API

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

In order 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 Relevance 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 parameters that you need. RichRelevance operates off a set of APIs that support many applications and clients concurrently. RichRelevance may update and enhance these APIs at any time. If you are building a mobile app, please use our mobile SDKs.

Note:  All parameters are case sensitive.

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 RichRelevance 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.)