Introduction
Our Data APIs enable you to retrieve many attributes and information types. Please refer to API Data Metrics for the different types of information and attributes which are retrievable via both our Historical and Real Time Data APIs.
Engagement Controller API is currently a Beta feature — users must agree to our Data Application Beta terms of use upon login. Please be aware that some elements and usability may change as we finalize this feature.
The Engagement Controller API extracts data according to the search query. The API allows brands to extract information about their engagements configured in Engagement Controller UI. The data includes engagement rule results.
This API is based on the REST architecture style, which allows clients to send HTTP requests to view Conversational Cloud operational data. This API supports the HTTP GET functionality (data retrieval), and all data is returned in JSON format.
Getting Started
A few things you'll need to get started with this API:
-
Retrieve your domain. Use the LivePerson Domain API to retrieve this information by providing either of the following service names:
- predictiveDialer
-
This API requires authorization using machine-to-machine authorization. Receive an authorization token (bearer) via below methods and use this token as your authorization header in all API requests.
-
OAuth 2.0 Client Credentials flow — follow the instructions, to register an OAuth 2.0 application and generate a JWT access token (Using version 2 of the Authorization API).
When registering an OAuth 2.0 application for using the Engagement Controller API, use the “pd.external.read” as the scope
-
-
Note the API terms of use.
Use Cases
-
Combine this information with other data sources to create your own real-time dashboard
-
Fetch engagement status (show/hide)