Live Leader

Live Chat 2.0

Login

Customer Login

Exporting data

Blog Navigation

LiveLeader data export API

Historical chat data can be accessed using a simple REST API (XML over HTTP). Note that not all plans support data export, please see our overview of plans.

Access point

The URL to use for access to the API is https://www.liveleader.com/a/Srv. HTTPS is strongly recommended, but HTTP is supported.

Request parameters

The following parameters are supported.

Parameter Comment
a
Required. Must be the exact value "export".
email Required. The email address of a valid LiveLeader operator. The operator must have account permission.
password
Required. The plaintext password of a valid LiveLeader operator account. The plan must support data export.
start
Required. The start time of the period for which data should be generated. Should be in ISO 8601 format. Example: 2008-08-18T19:24:18.884+02:00
stop Required. The end time of the period for which data should be generated. Should be in ISO 8601 format.Example: 2008-08-18T19:24:18.884+02:00.
Encoding

Parameters should be URL-encoded in UTF-8. All responses are UTF-8 encoded.

Example request

The following is an example GET request. Line breaks are for readability only.

https://www.liveleader.com/a/Srv?
a=export
&email=user%40yourdomain.com
&password=mypassword
&start=2008-02-25T00%3A00%3A00.000%2B02%3A00
&stop=2008-09-25T00%3A00%3A00.000%2B02%3A00

Response document

The response document has the following structure

<chats>
  <chat>
    <id>4c2789a6-0256-4382-842b-dfcbe44b719a</id>
    <referrer>http://www.referrer.com</referrer>
    <keywords>What the user searched for</keywords>
    <operator>operator@domain.com</operator>
    <visitorip>127.0.0.1</visitorip>
    <start>23-10-2008T12:49:1231</start>
    <stop>23-10-2008T12:49:1231</stop>
    <duration>125</duration>
    <url>http://www.domain.com/page</url>
   <city>Blakstad</city>
   <country>Norway</country>
   <organization>Priority Telecom Norway</organization>
   <ISP>Priority Telecom</ISP>
    <msg from="visitor" time="23-10-2008T12:49:1231">
      Hi there
    </msg>

    <msg from="operator@domain.com" time="23-10-2008T12:49:1231">
      Hi, how can I help?
    </msg>

   <userinfo>
   <entry key="CustomerNo">123456</entry>
   <entry key="CustomerCategory">VIP</entry>
   </userinfo>
   <survey context="entry">
     <response question="Name">John Doe</response>
     <response question="E-mail">john@domain.com</response>
   </survey>
   <survey context="exit">
     <response question="Rate our service">10</response>
   </survey>
  </chat>
  ...
</chats>

Response elements

The following elements are part of the response document.

Element Count
Comment
<chats>
1
Root element.
<chat> 0+
A chat session.
<id>
1
A unique ID for this chat.
<referrer>
0/1
The referring page for the chat.
<keywords>
0/1
Keywords the user searched for on a search engine.
<operator>
1+
The email address of the operator responding to the chat. If more than one operator responded, more <operator> elements are included.
<visitorip>
1
The visitor's IP address
<start>
1
Time of first message in chat in ISO 8601 format.
<stop> 1
Time of last message in chat in ISO 8601 format.
<duration>
1
Durartion of the chat in seconds.
<url>
1
The address of the page on which the chat occured.
<city>
0/1
Visitor city, if geolocation data is available.
<country>
0/1
Visitor country, if geolocation data is available.
<organization>
0/1
Visitor organization, if geolocation data is available.
<ISP>
0/1
Visitor ISP, if geolocation data is available.
<msg>
1+
A chat message. The from attribute can be either "visitor" or the email address of the operator sending the message. The time attribute is the send time for that message.
<userinfo>
0/1
If custom user info/metadata has been added, it will show up here, with one <entry> node for each item.
<userinfo>
0+
Present if the customer has responded to a survey (either on entry or exit).

Company Navigation

© Kalibera 2013. Powered by Amazon Web Services