LivePerson (v1) | Stitch Documentation

LivePerson is supported by the Singer community
This integration is powered by Singer's LivePerson tap. For support, visit the GitHub repo or join the Singer Slack.

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 (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status	Released on June 28, 2019	Supported by	Singer Community
Stitch plan	Standard	API availability	Available
Singer GitHub repository	singer-io/tap-liveperson
REPLICATION SETTINGS
Anchor Scheduling	Supported	Advanced Scheduling	Supported
Table-level reset	Unsupported	Configurable Replication Methods	Unsupported
DATA SELECTION
Table selection	Supported	Column selection	Supported
Select all	Supported
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

Note: This step requires the LivePerson API key administration privilege.

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:
1. Click the Show advanced options option.
2. Open the Data option.
3. Click the Data Access option. This should also automatically check the Data Access API option.
4. 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 replication start date

The Sync Historical Data setting defines the starting date for your LivePerson integration. This means that data 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

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the Replication Scheduling documentation for more information.

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:

Replication Frequency
Anchor Scheduling
Advanced Scheduling using Cron (Advanced or Premium plans only)

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 objects to replicate

Is an object missing or not replicating? Verify that the object meets the requirements for selection and replication.

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For LivePerson integrations, you can select:

Individual tables and columns
All tables and columns

Click the tabs to view instructions for each selection method.

In the integration’s Tables to Replicate tab, locate a table you want to replicate.
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
To track a column, click the checkbox next to the column’s name. A blue 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.

Important: Using the Select All feature will overwrite any previous selections. However, selections aren’t final until Finalize Your Selections is clicked. Clicking Cancel will restore your previous selections. Refer to the Select All guide for more info about this feature.

Click into the integration from the Stitch Dashboard page.
Click the Tables to Replicate tab.
In the list of tables, click the box next to the Table Names column.
In the menu that displays, click Track all Tables and Fields:
Click the Finalize Your Selections button at the bottom of the page to save your data selections.

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.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure to pause or delete the integration to prevent unwanted usage.

LivePerson table reference

Schemas and versioning

Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.

The schema and info displayed below is for version 1 of this integration.

This is the latest version of the LivePerson integration.

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

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.

Replication Method

Full Table

Primary Key

Useful links

agent_activity schema on GitHub

LivePerson API method

agent_activity table schema

_meta

OBJECT

Click to expand _meta

endTime

INTEGER

startTime

INTEGER

agentEmployeeId

OBJECT

Click to expand agentEmployeeId

string

STRING

agentGroupID

OBJECT

Click to expand agentGroupID

long

INTEGER

agentID

OBJECT

Click to expand agentID

long

INTEGER

agentLoginname

OBJECT

Click to expand agentLoginname

string

STRING

agentNickname

OBJECT

Click to expand agentNickname

string

STRING

agentUsername

OBJECT

Click to expand agentUsername

string

STRING

concurrentEng

OBJECT

Click to expand concurrentEng

long

INTEGER

STRING

maxConcurrentEng

OBJECT

Click to expand maxConcurrentEng

long

INTEGER

prevConcurrentEng

OBJECT

Click to expand prevConcurrentEng

long

INTEGER

prevState

OBJECT

Click to expand prevState

long

INTEGER

state

OBJECT

Click to expand state

long

INTEGER

timestamp

OBJECT

Click to expand timestamp

long

INTEGER

type

OBJECT

Click to expand type

long

INTEGER

agent_groups

The agent_groups table contains info about the agent groups in your LivePerson account.

Note: Stitch will query for and replicate deleted agent groups.

Replication Method

Full Table

Primary Key

Useful links

LivePerson documentation

agent_groups schema on GitHub

LivePerson API method

agent_groups table schema

deleted

BOOLEAN

description

STRING

isEnabled

BOOLEAN

name

STRING

parentGroupId

STRING

agent_state_distribution

The agent_state_distribution table contains info about the agent state distribution in your LivePerson account.

Replication Method

Full Table

Primary Key

Useful links

agent_state_distribution schema on GitHub

LivePerson API method

agent_state_distribution table schema

STRING

timestamp

INTEGER

agent_status

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.

Replication Method

Full Table

Primary Key

Useful links

LivePerson documentation

agent_status schema on GitHub

LivePerson API method

agent_status table schema

deleted

BOOLEAN

enabled

BOOLEAN

STRING

state

STRING

text

STRING

engagement_history

The engagement_history table contains info about the engagements in your LivePerson account.

Replication Method

Key-based Incremental

Primary Key

Useful links

LivePerson documentation

engagement_history schema on GitHub

LivePerson API method

engagement_history table schema

campaign

OBJECT

Click to expand campaign

behaviorSystemDefault

BOOLEAN

campaignEngagementId

STRING

campaignEngagementName

STRING

campaignId

STRING

campaignName

STRING

engagementAgentNote

STRING

engagementApplicationId

STRING

engagementApplicationName

STRING

engagementApplicationTypeId

STRING

engagementApplicationTypeName

STRING

engagementSource

STRING

goalId

STRING

goalName

STRING

lobId

INTEGER

lobName

STRING

locationId

STRING

locationName

STRING

profileSystemDefault

BOOLEAN

visitorBehaviorId

STRING

visitorBehaviorName

STRING

visitorProfileId

STRING

visitorProfileName

STRING

coBrowseSessions

OBJECT

Click to expand coBrowseSessions

coBrowseSessionsList

ARRAY

Click to expand coBrowseSessionsList

agentId

STRING

duration

INTEGER

endReason

STRING

endTime

DATE-TIME

endTimeL

INTEGER

interactive

BOOLEAN

sessionId

STRING

startTime

DATE-TIME

startTimeL

INTEGER

type

STRING

info

OBJECT

Click to expand info

accountId

STRING

agentDeleted

BOOLEAN

agentFullName

STRING

agentGroupId

STRING

agentGroupName

STRING

agentId

STRING

agentLoginName

STRING

agentNickName

STRING

alertedMCS

INTEGER

brandId

STRING

browser

STRING

channel

STRING

chatDataEnriched

STRING

chatMCS

INTEGER

chatRequestedTime

DATE-TIME

chatRequestedTimeL

INTEGER

chatStartPage

STRING

chatStartUrl

STRING

closeReason

STRING

closeReasonDescription

STRING

conversationId

STRING

csatRate

INTEGER

device

STRING

duration

INTEGER

endReason

STRING

endReasonDesc

STRING

endTime

DATE-TIME

endTimeL

INTEGER

ended

STRING

engagementId

STRING

engagementSequence

STRING

engagementSet

STRING

firstConversation

BOOLEAN

interactive

STRING

isAgentSurvey

STRING

isInteractive

STRING

isPartial

BOOLEAN

isPostChatSurvey

STRING

isPreChatSurvey

STRING

latestAgentFullName

STRING

latestAgentGroupId

INTEGER

latestAgentGroupName

STRING

latestAgentId

STRING

latestAgentLoginName

STRING

latestAgentNickname

STRING

latestQueueState

STRING

latestSkillId

INTEGER

latestSkillName

STRING

mcs

INTEGER

operatingSystem

STRING

sharkEngagementId

STRING

skillId

STRING

skillName

STRING

source

STRING

startReason

STRING

startReasonDesc

STRING

startTime

DATE-TIME

startTimeL

INTEGER

status

STRING

visitorId

STRING

visitorName

STRING

lineScores

ARRAY

Click to expand lineScores

lineRawScore

INTEGER

lineSeq

STRING

mcs

INTEGER

sdes

OBJECT

Click to expand sdes

events

ARRAY

Click to expand events

isAuthenticated

STRING

sdeType

STRING

serverTimeStamp

STRING

surveys

OBJECT

Click to expand surveys

postChat

ARRAY

Click to expand postChat

displayName

STRING

name

STRING

questionID

NUMBER

scope

STRING

source

STRING

surveyID

NUMBER

time

DATE-TIME

timeL

NUMBER

value

STRING

values

ARRAY

preChat

ARRAY

Click to expand preChat

displayName

STRING

name

STRING

questionID

NUMBER

scope

STRING

source

STRING

surveyID

NUMBER

time

DATE-TIME

timeL

NUMBER

value

STRING

values

ARRAY

transcript

OBJECT

Click to expand transcript

lines

ARRAY

Click to expand lines

agentId

STRING

cannedAnswerType

INTEGER

controlType

NUMBER

json

STRING

lineSeq

STRING

source

STRING

subType

STRING

text

STRING

textType

STRING

time

DATE-TIME

timeL

NUMBER

visitorInfo

OBJECT

Click to expand visitorInfo

browser

STRING

browserType

STRING

city

STRING

country

STRING

countryCode

STRING

device

STRING

ipAddress

STRING

isp

STRING

operatingSystem

STRING

org

STRING

state

STRING

messaging_interactions

The messaging_interactions table contains info about contact center messaging interactions.

Replication Method

Key-based Incremental

Primary Key

Useful links

LivePerson documentation

messaging_interactions schema on GitHub

LivePerson API method

messaging_interactions table schema

agentParticipants

ARRAY

Click to expand agentParticipants

agentFullName

STRING

agentGroupId

INTEGER

agentGroupName

STRING

agentId

STRING

agentLoginName

STRING

agentNickname

STRING

permission

STRING

role

STRING

time

DATE-TIME

timeL

INTEGER

userType

STRING

userTypeName

STRING

campaign

OBJECT

Click to expand campaign

behaviorSystemDefault

BOOLEAN

campaignEngagementId

STRING

campaignEngagementName

STRING

campaignId

STRING

campaignName

STRING

engagementAgentNote

STRING

engagementApplicationId

STRING

engagementApplicationName

STRING

engagementApplicationTypeId

STRING

engagementApplicationTypeName

STRING

engagementSource

STRING

goalId

STRING

goalName

STRING

lobId

INTEGER

lobName

STRING

locationId

STRING

locationName

STRING

profileSystemDefault

BOOLEAN

visitorBehaviorId

STRING

visitorBehaviorName

STRING

visitorProfileId

STRING

visitorProfileName

STRING

coBrowseSessions

OBJECT

Click to expand coBrowseSessions

coBrowseSessionsList

ARRAY

Click to expand coBrowseSessionsList

agentId

STRING

duration

INTEGER

endReason

STRING

endTime

DATE-TIME

endTimeL

INTEGER

interactive

BOOLEAN

sessionId

STRING

startTime

DATE-TIME

startTimeL

INTEGER

type

STRING

consumerParticipants

ARRAY

Click to expand consumerParticipants

avatarURL

STRING

consumerName

STRING

email

STRING

firstName

STRING

lastName

STRING

participantId

STRING

phone

STRING

time

DATE-TIME

timeL

INTEGER

token

STRING

conversationSurveys

ARRAY

Click to expand conversationSurveys

surveyData

ARRAY

Click to expand surveyData

answer

STRING

question

STRING

surveyStatus

STRING

surveyType

STRING

info

OBJECT

Click to expand info

agentDeleted

BOOLEAN

alertedMCS

INTEGER

brandId

STRING

browser

STRING

closeReason

STRING

closeReasonDescription

STRING

conversationId

STRING

csatRate

NUMBER

device

STRING

duration

INTEGER

endTime

STRING

endTimeL

INTEGER

firstConversation

BOOLEAN

isPartial

BOOLEAN

latestAgentFullName

STRING

latestAgentGroupId

INTEGER

latestAgentGroupName

STRING

latestAgentId

STRING

latestAgentLoginName

STRING

latestAgentNickname

STRING

latestQueueState

STRING

latestSkillId

INTEGER

latestSkillName

STRING

mcs

INTEGER

operatingSystem

STRING

source

STRING

startTime

DATE-TIME

startTimeL

INTEGER

status

STRING

interactions

ARRAY

Click to expand interactions

assignedAgentFullName

STRING

assignedAgentId

STRING

assignedAgentLoginName

STRING

assignedAgentNickname

STRING

interactionTime

DATE-TIME

interactionTimeL

INTEGER

interactiveSequence

INTEGER

messageRecords

ARRAY

Click to expand messageRecords

device

STRING

dialogId

STRING

messageData

OBJECT

Click to expand messageData

msg

OBJECT

Click to expand msg

text

STRING

messageId

STRING

participantId

STRING

sentBy

STRING

seq

INTEGER

source

STRING

time

DATE-TIME

timeL

INTEGER

type

STRING

messageScores

ARRAY

Click to expand messageScores

mcs

INTEGER

messageId

STRING

messageRawScore

INTEGER

time

DATE-TIME

timeL

INTEGER

messageStatuses

ARRAY

Click to expand messageStatuses

messageDeliveryStatus

STRING

messageId

STRING

participantId

STRING

participantType

STRING

seq

INTEGER

time

DATE-TIME

timeL

INTEGER

monitoring

OBJECT

Click to expand monitoring

browser

STRING

city

STRING

conversationStartPage

STRING

conversationStartPageTitle

STRING

country

STRING

countryCode

STRING

device

STRING

ipAddress

STRING

isp

STRING

operatingSystem

STRING

org

STRING

state

STRING

sdes

OBJECT

Click to expand sdes

events

ARRAY

Click to expand events

serverTimeStamp

STRING

summary

OBJECT

Click to expand summary

lastUpdatedTime

INTEGER

text

STRING

transfers

ARRAY

Click to expand transfers

assignedAgentId

STRING

reason

STRING

sourceAgentFullName

STRING

sourceAgentId

STRING

sourceAgentLoginName

STRING

sourceAgentNickname

STRING

sourceSkillId

INTEGER

sourceSkillName

STRING

targetSkillId

INTEGER

targetSkillName

STRING

time

DATE-TIME

timeL

INTEGER

unAuthSdes

OBJECT

Click to expand unAuthSdes

events

ARRAY

Click to expand events

serverTimeStamp

INTEGER

messaging_queue_health

The messaging_queue_health table contains messaging queue-related metrics.

Replication Method

Full Table

Primary Key

Useful links

messaging_queue_health schema on GitHub

LivePerson API method

messaging_queue_health table schema

actionableAndConsumerLastMessage

NUMBER

actionableAndDuringTransfer

NUMBER

actionableAndManualSla

NUMBER

actionableConversations

NUMBER

avgWaitTimeForAgentAssignment_AfterTransfer

NUMBER

avgWaitTimeForAgentAssignment_AfterTransferFromAgent

NUMBER

avgWaitTimeForAgentAssignment_AfterTransferFromBot

NUMBER

avgWaitTimeForAgentAssignment_NewConversation

NUMBER

STRING

maxWaitTimeForAgentAssignment

NUMBER

maxWaitTimeForAgentAssignment_AfterTransferFromAgent

NUMBER

notActionableAndManualSla

NUMBER

notActionableConversations

NUMBER

notActionableDuringTransfer

NUMBER

skill

STRING

timestamp

INTEGER

unassignedConversations

NUMBER

unassignedConversationsAndFirstTimeConsumer

NUMBER

waitTimeForAgentAssignment_50thPercentile

NUMBER

waitTimeForAgentAssignment_90thPercentile

NUMBER

queue_health

The queue_health table contains queue-related metrics.

Replication Method

Full Table

Primary Key

Useful links

queue_health schema on GitHub

LivePerson API method

queue_health table schema

abandonedEng

NUMBER

abandonmentRate

NUMBER

availableSlotsCount

NUMBER

availableSlotsSum

NUMBER

averageAvailableSlots

NUMBER

averageQueueSize

NUMBER

avgTimeToAbandon

NUMBER

avgTimeToAnswer

NUMBER

connectedEng

NUMBER

currentAvailableSlots

NUMBER

currentQueueSize

NUMBER

enteredQEng

NUMBER

STRING

maxAvailableSlots

NUMBER

maxQueueSize

NUMBER

minAvailableSlots

NUMBER

minQueueSize

NUMBER

queueSizeCount

NUMBER

queueSizeSum

NUMBER

skill

STRING

timestamp

INTEGER

totalTimeToAbandon

NUMBER

totalTimeToAnswer

NUMBER

skills

The skills table contains info about the agent skills in your LivePerson account.

Note: Stitch will query for and replicate deleted skills.

Replication Method

Full Table

Primary Key

Useful links

LivePerson documentation

skills schema on GitHub

LivePerson API method

skills table schema

deleted

BOOLEAN

STRING

name

STRING

pid

STRING

users

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.

Replication Method

Full Table

Primary Key

Useful links

LivePerson documentation

users schema on GitHub

LivePerson API method

users table schema

deleted

BOOLEAN

STRING

loginName

STRING

pid

STRING

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.

Related	Troubleshooting
Destination & Integration Compatibility Replication Scheduling Syncing Historical SaaS Data Resetting Replication Keys Nested Data Structures & Row Count Impact	Third-Party Downtime Understanding & Reducing Your Usage Re-Authorizing Integrations Replication Issues