Acquia Lift REST API reference

Subscribers with access to Omnichannel can use a REST API to integrate their websites and applications with Acquia Lift.

Using the REST API

Similar to many other APIs, the Acquia Lift API uses standard HTTP methods to communicate with Acquia Lift, including GET, PUT, and DELETE. You can view the list of available Acquia Lift REST API calls at the following URL:

http://docs.lift.acquia.com/profilemanager

You can also view REST API information at [region-based endpoint]-api.lift.acquia.com, replacing [region-based endpoint] with the server for your local Profile Manager Admin region, such as us-east-1, eu-central-1, or ap-southeast-2.

Keys and access information

Acquia will provide you with your keys after you subscribe to Omnichannel.

Users with the following permissions can view credentials and access information:

  • Experience Builder Admin
  • Content Hub Admin
  • REST API Goals
  • REST API Segments

If a user has one of the previous permissions, complete the following steps to view access information:

  1. Sign in to the Profile Manager interface.
  2. Click the Admin tab.
  3. Click the Manage customers link.

The Profile Manager will display the Customer information page, which includes your key information. In most circumstances, the page will display only a single result — your own customer subscription. If more than one website is displayed, click the Account ID of the desired subscription.

Sample Acquia Lift API methods

Here are some examples of the methods provided in the Acquia Lift API:

REST API call Description
capture Capture API accepts captures and returns segments matched by the captures
event_import Import one or more events for a person into Acquia Lift
events Create or delete individual event types
export_visitor_data Export visitor data from Acquia Lift as files
export_visitor_data_status Report on the status of an export process initiated by export_visitor_data
goals Obtain information about goals in Acquia Lift
segments Obtain information about segments in Acquia Lift
visitor_query Return visitor data for a single person from Acquia Lift

API call format

Use the following URL structure when you send commands to the Acquia Lift API:

{region-based endpoint}/{account_id}/{command}

where:

  • {region-based endpoint} is the API server URL of the Profile Manager Admin. This information may be provided to you with your keys, and is available from your Insight page. This varies based on your assigned API server.
  • {account_id} is your customer account ID.
  • {command} is the operation that you want to complete.

The API service request uses an HMAC-SHA256 message hash, with the following required request header for its authorization:

Authorization : HMAC {access_key_id}:{signature}

where:

  • {access_key_id} is an access key string that is used to select the corresponding secret access key.
  • {signature} is an HMAC-SHA256 hash of the canonical representation of the request, using the secret access key.
    Accept, Host, User-Agent, and sorted query string are used as the payload to calculate HMAC signature.

Contact supportStill need assistance? Contact Acquia Support