Note: LivePerson provides the Data Access Service as an optional feature for LivePerson clients. For more information, please contact your Account Manager or Sales representative.

Base Resource

The first resource that you should access is the Base Resource. In order to start using the Data Access API, issue a GET request to the following URL:

 The GET request should be oAuth signed, as explained in the REST Overview: Requests document in the Developers Community. The oAuth signature should include the following four parameters:

  • Consumer Key - the Application Key that should be retrieved from your LivePerson Account Manager. 
  • Consumer Secret -  the Application Secret that should be retrieved from your LivePerson Account Manager. 
  • Token - from the Admin Console in Account Set Up > Applications > Application Name. The Verification Code holds the Token and Token Secret concatenated with a semicolon. 
  • Token Secret - from the Admin Console in Account Set Up > Applications > Application Name. The Verification Code holds the Token and Token Secret concatenated with a semicolon.

Applications Area


Once you follow the redirection link, you will receive an XML or JSON response with links to the available resources for that account. You should use these resources as described in this document. They will lead you to additional resources as appropriate.

Example of Data Access API resources for account #12345678

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><account id="12345678"> 
<link rel="self" href="https://dacv.liveperson.net/dataAccess/account/12345678"/> 
<link rel="visitor-session" href="https://dacv.liveperson.net/dataAccess/account/12345678/visitorSession"/>
<link rel="agent-state" href="http://dacv.liveperson.net/dataAccess/account/12345678/agentState"/> </account>

Elements in the Response

Name Description Type/Value
account LivePerson account number agent-state
visitor-session URI to check visitor-session functions link relationship
agent-state URI to check the agent"s state link relationship


Visitor Session

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <visitorSessionFiles id="qa50239173"> <link rel="self" href="https:// dacv.liveperson.net/dataAccess/account/qa50239173/visitorSession"/> <file href=https://dacv.liveperson.net/dataAccess/account/12345678/ visitorSession/12345678_visitorSession_0711201101_0711201102.gzscopeEndDate="2011-11-07T02:00:00-05:00" scopeStartDate="2011-11-07T01:00:00-05:00" name="12345678_visitorSession_0711201101_0711201102.gz"/> <file href=https://dacv.liveperson.net/dataAccess/account/12345678/ visitorSession/12345678_visitorSession_3110201111_3110201112- r-00000.gzscopeEndDate="2011-10-31T12:00:00-04:00" scopeStartDate="2011-10-31T11:00:00-04:00" name="12345678_visitorSession_3110201111_3110201112-r-00000.gz"/ > <file href=https://dacv.liveperson.net/dataAccess/account/12345678/ visitorSession/12345678_visitorSession_3110201112_3110201113- r-00000.gzscopeEndDate="2011-10-31T13:00:00-04:00" scopeStartDate="2011-10-31T12:00:00-04:00" name="12345678_visitorSession_3110201112_3110201113-r-00000.gz"/ > <file href=https://dacv.liveperson.net/dataAccess/account/12345678/ visitorSession/12345678_visitorSession_3110201113_3110201114- r-00000.gzscopeEndDate="2011-10-31T14:00:00-04:00" scopeStartDate="2011-10-31T13:00:00-04:00" name="12345678_visitorSession_3110201113_3110201114-r-00000.gz"/ > <file href=https://dacv.liveperson.net/dataAccess/account/12345678/ visitorSession/12345678_visitorSession_3110201114_3110201115- r-00000.gzscopeEndDate="2011-10-31T15:00:00-04:00" scopeStartDate="2011-10-31T14:00:00-04:00" name="12345678_visitorSession_3110201114_3110201115-r-00000.gz"/> </ visitorSessionFiles>


 

  • Response JSON Example:
{"visitorSessionFiles" :{"@id":"12345678","link": { "@rel":"self","@href":"https://dacv.liveperson.net/ dataAccess/account/12345678/visitorSession"}, "file":[ {"@href":"https://dacv.liveperson.net/ dataAccess/account/12345678/visitorSession/12345678_visitorSession_0711201101_0711201102.gz", "@scopeEndDate":"2011-11-07T02:00:00-05:00", "@scopeStartDate":"2011-11-07T01:00:00-05:00", "@name":"12345678_visitorSession_0711201101_0711201102.gz" }, {"@href":"https://dacv.liveperson.net/dataAccess/account/12345678/ visitorSession/12345678_visitorSession_3110201111_3110201112-r-00000.gz", "@scopeEndDate":"2011-10-31T12:00:00-04:00", "@scopeStartDate":"2011-10-31T11:00:00-04:00", "@name":"12345678_visitorSession_3110201111_3110201112-r-00000.gz" }, {"@href":"https://dacv.liveperson.net/dataAccess/account/12345678/ visitorSession/12345678_visitorSession_3110201112_3110201113-r-00000.gz", "@scopeEndDate":"2011-10-31T13:00:00-04:00", "@scopeStartDate":"2011-10-31T12:00:00-04:00", "@name":"12345678_visitorSession_3110201112_3110201113-r-00000.gz" }, {"@href":"https://dacv.liveperson.net/dataAccess/account/12345678/ visitorSession/12345678_visitorSession_3110201113_3110201114-r-00000.gz", "@scopeEndDate":"2011-10-31T14:00:00-04:00", "@scopeStartDate":"2011-10-31T13:00:00-04:00", "@name":"12345678_visitorSession_3110201113_3110201114-r-00000.gz"}, {"@href":"https://dacv.liveperson.net/dataAccess/account/12345678/ visitorSession/12345678_visitorSession_3110201114_3110201115-r-00000.gz", "@scopeEndDate":"2011-10-31T15:00:00-04:00", "@scopeStartDate":"2011-10-31T14:00:00-04:00", "@name":"12345678_visitorSession_3110201114_3110201115-r-00000.gz" } ] } }

 

  • Elements in the Response
Name Description Type/Value
href File location to be initiated. agent-state
scopeStartDate Insertion time boundaries. This value represent the start date, rounded by hour. ISO standard
scopeEndDate Insertion time boundaries. This value represent the start date, rounded by hour. ISO standard
name The name of the file. alphanumeric

Agent State

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <agentStateFiles id="12345678"> <link rel="self" href="https://dacv.liveperson.net/dataAccess/ account/12345678/agentState"/> <file href="https://dacv.liveperson.net/dataAccess/ account/12345678/agentState/12345678_agentState_0711201101_0711201102.gz" scopeEndDate="2011-11-07T02:00:00-05:00" scopeStartDate="2011-11-07T01:00:00-05:00" name="12345678_agentState_0711201101_0711201102.gz"/> <file href="https://dacv.liveperson.net/ dataAccess/account/12345678/agentState/12345678_agentState_0711201102_0711201103.gz" scopeEndDate="2011-11-07T03:00:00-05:00" scopeStartDate="2011-11-07T02:00:00-05:00" name="12345678_agentState_0711201102_0711201103.gz"/> <file href="https://dacv.liveperson.net/ dataAccess/account/12345678/agentState/12345678_agentState_0711201103_0711201104.gz" scopeEndDate="2011-11-07T04:00:00-05:00" scopeStartDate="2011-11-07T03:00:00-05:00" name="12345678_agentState_0711201103_0711201104.gz"/> <file href="https://dacv.liveperson.net/ dataAccess/account/12345678/agentState/12345678_agentState_0711201104_0711201105.gz" scopeEndDate="2011-11-07T05:00:00-05:00" scopeStartDate="2011-11-07T04:00:00-05:00" name="12345678_agentState_0711201104_0711201105.gz"/> <file href="https://dacv.liveperson.net/ dataAccess/account/12345678/agentState/12345678_agentState_0711201105_0711201106.gz" scopeEndDate="2011-11-07T06:00:00-05:00" scopeStartDate="2011-11-07T05:00:00-05:00" name="12345678_agentState_0711201105_0711201106.gz"/> </agentStateFiles>

 

  • Response JSON Example
"agentStatefiles" : {"@id":"12345678","link": { "@rel":"self","@href":"https:// dacv.liveperson.net/dataAccess/account/12345678/agentState"}, "file": [ {"@href":"https://dacv.liveperson.net/dataAccess/account/12345678/ agentState/12345678_agentState_0711201101_0711201102.gz", "@scopeEndDate":"2011-11-07T02:00:00-05 :00","@scopeStartDate":"2011-11-07T01:00:00-05:00", "@name":"12345678_agentState_0711201101_0711201102.gz" }, {"@href":"https://dacv.liveperson.net/dataAccess/account/12345678/ agentState/12345678_agentState_0711201102_0711201103.gz", "@scopeEndDate":"2011-11-07T03:00:00-05:00", "@scopeStartDate":"201 1-11-07T02:00:00-05:00", "@name":"12345678_agentState_0711201102_0711201103.gz" }, {"@href":"https://dacv.liveperson.net/dataAccess/account/12345678/ agentState/12345678_agentState_0711201103_0711201104.gz", "@scopeEndDate":"2011-11-07T04:00:00-05:00", "@scopeStartDate":"2011-11-07T03:00:00-05:00", "@name":"12345678_agentState_0711201103_0711201104.gz" }, {"@href":"https://dacv.liveperson.net/dataAccess/account/12345678/ agentState/12345678_agentState_0711201104_0711201105.gz", "@scopeEndDate":"2011-11-07T05:00:00-05:00", "@scopeStartDate":"2011-11-07T04:00:00-05:00", "@name":"12345678_agentState_0711201104_0711201105.gz" }, {"@href":"https://dacv.liveperson.net/dataAccess/account/12345678/ agentState/12345678_agentState_0711201105_0711201106.gz", "@scopeEndDate":"2011-11-07T06:00:00-05:00", "@scopeStartDate":"2011-11-07T05:00:00-05:00", "@name":"12345678_agentState_0711201105_0711201106.gz" } ] } }
  • Elements in the Response
Name Description Type/Value
href File location to be initiated. agent-state
scopeStartDate Insertion time boundaries. This value represent the start date, rounded by hour. ISO standard
scopeEndDate Insertion time boundaries. This value represent the start date, rounded by hour. ISO standard
name The name of the file. alphanumeric

Agent State File

  • Description:
    Initiates an agent state file request according to the given parameters that describe this file. If successful, a file download will start

  • URI:
    This resource is accessed from the agentStateFiles href in response to the Agent State URI GET request.

  • Initiating an Agent State File:
    If successful a 200 OK status code response is returned.

  • HTTP Method: GET

  • Formats: Text

  • Response:
    The application response is of type Application/Octet-Stream that contains the following:
    • Status code
    • Downloaded file

The name of the returned file will be in the format: siteId_agentState_startDate_endDate.gz.

Data Type Description XSD Schema
Agent State Agent state metrics AgentState.xsd

 

Visitor Session File 

 

  • Description:
    Initiates a visitor session file request according to the given parameters that describe this file. If successful, a file download will start.

  • URI:
    This resource is accessed from the visitorSessionFiles href in response to the Visitor Session URI GET request.

  • Initiating a Visitor Session File:
    If successful a 200 OK status code response is returned

  • HTTP Method: GET

  • Formats: Text

  • Response:
    The application response is of type Application/Octet-Stream that contains the following:
    • Status code
    • Downloaded file

The name of the returned file will be in the format: siteId_visitorSession_startDate_endDate.gz.

Data Type Description XSD Schema
Session Chat/Voice visitor session metrics Session.xsd