Admin

Administrative tasks such as pinging the server to see if it is still alive.

get

Ping the server.

get

Ping the server

Capture

The Capture endpoint allows you to send visitor information over to the Acquia Lift Profile Manager system so that you can track customers behavior throughout their journey on your site.

post

Capture events without making a decision

get

Capture events without making a decision

Content

Fetches an individual content item from the content connector including all the view modes with their HTML rendered representation.

get

Retrieve a list of content. This endpoint is currently not implemented.

An individual content piece.

get

Get a piece of content

Content connector

Allows a specific client to connect to a list of allowed Content connectors such as a json content connector (accessible file that lists up the available content) or connection with Acquia Content Hub. List is ordered by content connector identifier, ascending.

get

Get a list of all content_connectors, optionally filtered. See the query parameters for a list of filter options.

post

Create or update a content connector

An individual content connector.

get

Get a content connector

delete

This method will delete an individual content_connector

Content metadata

Lists content metadata of all user content. Specifically, map of uuid<-->name will be returned for all content sources and content tags.

get

Some requests can be filtered by user id.

Decide

an endpoint to make a decision for an unique user and a specific slot. This decision is influenced by a list of given segments that this user belongs to. This call is text/plain on purpose. The whole reason for that is that there is a concept of simple requests and complex requests when making javascript calls to external services. Since we are using CORS we want to avoid the "pre-flight". pre-flight request are required in order to let the server accept custom headers when your requests wants to send them. See the definition here: http://www.w3.org/TR/cors/#simple-method. As a client, do not call this request with custom headers other than shown in the w3 resource and also not with any other content type than text/plain.

The request should always include the origin and referer headers so that the decide endpoint can automatically deduce which rules apply to the decide request. Optionally extra slots can be provided for which we want to retrieve decisions.

post

Make a decision

Decide JS

Returns the decisions in a format that Lift V3 understands: Javascript.

Same characteristics as the /decide endpoint. Separated this as own endpoint because of the same reason. Any additional header that is not "simple" will cause a pre-flight to happen.

post

Make a decision and return JS specific to Lift 3

External JSON Example. NOT AN ENDPOINT.

DO NOT IMPLEMENT OR EXPECT THIS ENDPOINT. Useful to understand what syntax the External JSON we support as a content connector should be. Can only be used to view the JSON schema that is supported in the local file content connector config.

get

Get a list of content ids and their view mode.

Filters

Filters can be used to narrow down search results. Filters can be created (saved), modified, retrieved, and deleted.

get

Returns a list of filters that belong to that client.

post

This method will save/update an individual filter.

Perform an operation on an individual filter.

get

This method will get an individual filter.

put

This method will save/update an individual filter.

delete

This method will delete an individual filter.

Goals

A goal is a desired outcome. It is the motivation for running a personalization campaign that is used to measure the effectiveness of a campaign and provide feedback into the decision algorithms

get

Get a list of goals.

post

Create/Update a new goal. When POST'ing a goal with the same identifier, it will update that existing goal.

An individual goal.

get

Get a goal

delete

Delete an individual goal

Report

Reports will give you a detailed report of the personalization and how it is performing.

get

Get a report that shows the result of the personalization

get

Get a report by target that shows the result of the personalization

get

Get a report by test that shows the result of the personalization

Rules

Defines the rules that we use to evaluate how we need to fill in a slot. Each slot can have multiple rules and a rule consists of a content_mapping entity, a view mode of that specific content entity and the decision_connector in the case of multiple content_mapping identifiers in a single rule.

get

Get a list of all rules, optionally filtered. See the query parameters for a list of filter options.

post

Create/Update a new rule When POST'ing a rules with the same identifier, it will update that existing rules and change the updated timestamp. The newly created resource can be referenced by the URI(s) returned in the entity of the response, with the most specific URI for the resource given by a Location header field

delete

This method will delete all rules belonging to the given account (or a site, if site id is also given).

An individual rule.

get

Get a rule

delete

This method will delete an individual rule

Find available content through all content_connectors for this user by keyword, origins, tags, content type, and date.

Segments

Gets a list of segments that are available to this Acquia Lift account. Internally this consumes http://docs.lift.acquia.com/profilemanager/#segments_get. List is ordered ascending.

get

Get a list of Segments

Settings

Modifies global settings per client such as domain restrictions of the decide call.

get

Get the client specific settings

post

Set the client specific settings. Always post the full settings schema. The server-side application will take care of only updating the changed values.

Slots

Defines the slots that are available to place somewhere on a remote site. This API call gives you the possibility to create more supported slots to be placed on your website or to de-activate certain slots permanently or temporarily. List is ordered by slot identifier, ascending.

get

Get a list of all slots, optionally filtered. See the query parameters for a list of filter options.

post

Create/Update a new slot When POST'ing a slots with the same identifier, it will update that existing slots and change the updated timestamp. The newly created resource can be referenced by the URI(s) returned in the entity of the response, with the most specific URI for the resource given by a Location header field

delete

This method will delete all slots belonging to the given account (or a site, if site id is also given).

An individual slot.

get

Get a slot

delete

This method will delete an individual slot

Statistics

The service collects 3 types of statistical data, system-wide, client-wide and custom statistics about successful and failed requests, etc...

delete

This method will delete all statistics belonging to the given account (or a site, if site id is also given).

Visitor Query

Return visitor information.

get

Some requests can be filtered by user id.