Please note that this API relates to LivePersons legacy chat product which receives limited support and will be deprecated in the future.
It is recommended to build future integrations on top of LivePersons Key Messaging Metrics API instead.
Introduction
Our Data APIs enable you to retrieve many attributes and information types. Please see this table for the different types of information and attributes which are retrievable via both our Historical and Real Time Data APIs.
The Conversational Cloud Operational Real-Time API provides real-time information about contact center performance.
Using this API, Agent Managers can measure contact center performance at account level, at skill level, or even drill down to agent level. Data is provided for the previous 24 hours, up to the last 5 minutes, with a refresh rate of 10 seconds.
The Operational Real-Time 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.
Agent Managers can also leverage the Operational Real-Time API to build new real-time dashboards, integrate with existing dashboards solutions, or even connect to workforce management systems (WFM). The Operational Real-Time 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.
It is possible to leverage the Operational Real-Time API to build your own real-time dashboards, integrate with existing dashboards solutions, or even connect to workforce management systems (WFM).
Benefits:
-
Combine different data sources to a unified contact center dashboard.
-
Customize your manager and executive dashboards and alerts.
-
Monitor performance at account level, skill level or agent level.
Note: Conversational Cloud and our Analytics Builder functionality provide you with a slew of reports and dashboards. Before you invest time in developing your own dashboards, we recommend that you first review what’s available to ensure your needs are not already met out of the box.
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 the following service name:
- leDataReporting
-
This API requires authorization using API key.
- Follow the instructions, to create and use an API key.
-
Note the API terms of use.
Use cases
-
Integrations with WFM (workforce management) tools such as NICE IEX and Verint WFM. This provides real-time visibility into the agent status in LE system. This enables the brand to track scheduling adherence and take early action in order to solve issues.
-
Create your own real-time dashboard
Example of a dashboard created with this data:
