The Activity API is used for server-side personalization, amongst other things, and allows the retrieval of personalized content.

In order to call the API you must have your account ID from your Fresh Relevance account. To find this, expand the User menu and copy the Account ID value.

Domain

The API is available at your Activity domain.

To find this, in Fresh Relevance, expand the User menu, then go to Settings > System configuration > Custom domains and copy the domain from the Activity Domain field.

OAS / Swagger

Download OAS / Swagger specification

Authorization

None required.

Scoping

To ensure we scope the calls to the correct account/website you must pass your Account/Website ID in the path of each call to the API in the website_id parameter.

Security

The API is served on both HTTP and HTTPS using TLS 1.2 or higher for security.