This integration is powered by Singer's LivePerson tap. For support, visit the GitHub repo or join the Singer Slack.
LivePerson is in Open Beta
LivePerson is currently in Open Beta. The info in this article is subject to change.
LivePerson integration summary
Stitch’s LivePerson integration replicates data using the LivePerson Data Access API. Refer to the Schema section for a list of objects available for replication.
LivePerson feature snapshot
A high-level look at Stitch's LivePerson integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release Status |
Open Beta |
Supported By | |
Stitch Plan |
Free |
Singer GitHub Repository | |
DATA SELECTION | |||
Table Selection |
Supported |
Column Selection |
Supported |
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Unsupported |
Table-level Reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting LivePerson
LivePerson setup requirements
To set up LivePerson in Stitch, you need:
-
The API key administration privilege in LivePerson. This is required to generate API credentials in LivePerson.
Step 1: Generate LivePerson API credentials
- Sign into your LivePerson account.
- Click the Campaigns tab at the top of the page.
- On the Campaigns page, locate and click on the Data Sources link.
- On the Data Sources page, click the API tab.
- Click + Add new.
- In the Application details section, enter
Stitch
into the Application name and Developer name fields. - In the Select APIs section:
- Click the Show advanced options option.
- Open the Data option.
- Click the Data Access option. This should also automatically check the Data Access API option.
- Click the Engagement History / Messaging Interactions option. This should also automatically check the Interaction History option.
- When finished, click the Save button in the lower right corner of the page.
An Authentication details section will display. Leave this page open for now - you’ll need it in the next step.
Step 2: Add LivePerson as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the LivePerson icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch LivePerson” would create a schema called
stitch_liveperson
in the destination. Note: Schema names cannot be changed after you save the integration. - In the LivePerson App Key field, paste value from the App key field in LivePerson.
- In the LivePerson App Secret field, paste the value from the Secret field in LivePerson.
- In the LivePerson Access Token field, paste the value from the Access token field in LivePerson.
- In the LivePerson Access Token Secret field, paste the value from the Access token secret field in LivePerson.
- In the LivePerson Account ID field, enter your LivePerson account ID.
Step 3: Define the historical sync
The Sync Historical Data setting will define the starting date for your LivePerson integration. This means that:
- For tables using Incremental Replication, data equal to or newer than this date will be replicated to your data warehouse.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond LivePerson’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
LivePerson integrations support the following replication scheduling methods:
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 5: Set tables and columns to replicate
To complete the setup, you’ll need to select the tables and columns you want to replicate to your data warehouse.
Check out the Schema section to learn more about the available tables in LivePerson and how they replicate.
- In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A green checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.
Initial and historical replication jobs
After you finish setting up LivePerson, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
LivePerson table schemas
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
agent_activity
Replication Method : |
Full Table |
Primary Key : |
id |
API endpoint : |
The agent_activity
table contains info about agent session data. Activity data is a list of sessions that occur from the agent’s login time to their logout time.
id
|
|
_meta
|
|
agentEmployeeId
|
|
agentGroupID
|
|
agentID
|
|
agentLoginname
|
|
agentNickname
|
|
agentUsername
|
|
concurrentEng
|
|
maxConcurrentEng
|
|
prevConcurrentEng
|
|
prevState
|
|
state
|
|
timestamp
|
|
type
|
agent_groups
Replication Method : |
Full Table |
Primary Key : |
id |
API endpoint : |
The agent_groups
table contains info about the agent groups in your LivePerson account.
Note: Stitch will query for and replicate deleted agent groups.
id
|
deleted
|
description
|
isEnabled
|
name
|
parentGroupId
|
agent_status
Replication Method : |
Full Table |
Primary Key : |
id |
API endpoint : |
The agent_status
table contains data for each of the agent statuses in your LivePerson account.
Note: Stitch will query for and replicate deleted agent statuses.
id
|
deleted
|
enabled
|
state
|
text
|
engagement_history
Replication Method : |
Key-based Incremental |
Replication Key : |
updated_at |
Primary Key : |
id |
API endpoint : |
The engagement_history
table contains info about the engagements in your LivePerson account.
id
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
coBrowseSessions
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
info
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lineScores
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sdes
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
surveys
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transcript
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
visitorInfo
|
messaging_interactions
Replication Method : |
Key-based Incremental |
Replication Key : |
updated_at |
Primary Key : |
id |
API endpoint : |
The messaging_interactions
table contains info about contact center messaging interactions.
id
|
|||||||||||||||||||||||||||||
agentParticipants
|
|||||||||||||||||||||||||||||
campaign
|
|||||||||||||||||||||||||||||
coBrowseSessions
|
|||||||||||||||||||||||||||||
consumerParticipants
|
|||||||||||||||||||||||||||||
conversationSurveys
|
|||||||||||||||||||||||||||||
info
|
|||||||||||||||||||||||||||||
interactions
|
|||||||||||||||||||||||||||||
messageRecords
|
|||||||||||||||||||||||||||||
messageScores
|
|||||||||||||||||||||||||||||
messageStatuses
|
|||||||||||||||||||||||||||||
sdes
|
|||||||||||||||||||||||||||||
summary
|
|||||||||||||||||||||||||||||
transfers
|
queue_health
Replication Method : |
Full Table |
Primary Key : |
id |
API endpoint : |
The queue_health
table contains queue-related metrics.
id
|
abandonedEng
|
abandonmentRate
|
availableSlotsCount
|
availableSlotsSum
|
averageAvailableSlots
|
averageQueueSize
|
avgTimeToAbandon
|
avgTimeToAnswer
|
connectedEng
|
currentAvailableSlots
|
currentQueueSize
|
enteredQEng
|
maxAvailableSlots
|
maxQueueSize
|
minAvailableSlots
|
minQueueSize
|
queueSizeCount
|
queueSizeSum
|
skill
|
timestamp
|
totalTimeToAbandon
|
totalTimeToAnswer
|
skills
Replication Method : |
Full Table |
Primary Key : |
id |
API endpoint : |
The skills
table contains info about the agent skills in your LivePerson account.
Note: Stitch will query for and replicate deleted skills.
id
|
deleted
|
name
|
pid
|
Replication Method : |
Full Table |
Primary Key : |
id |
API endpoint : |
The users
table contains info about the users in your LivePerson account. This includes agents, agent managers, administrators, and campaign managers.
Note: Stitch will query for and replicate deleted users.
id
|
deleted
|
loginName
|
pid
|
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.