Conversations: view metadata

Retrieves the metadata associated with chats for all queues over a specified time period. Chat metadata includes:

  • chat ID
  • JID (Jabber ID)
  • name of the queue on which the chat originated
  • profile page
  • time the chat started in ISO 8601 format with timezone
  • wait time before the chat was answered in integer seconds
  • duration of the chat in integer seconds
  • the operator's username
  • the IP address of the
  • the HTML page from which the initiated the chat
  • the categories with which a chat is tagged

Authentication

LibraryH3lp supports cookie-based authentication. To learn more, you can read the details on authentication.

HTTP and HTTPS

Requests are served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

URI

/2011-12-03/conversations/{YYYY}/{MM}/{DD}

HTTP GET

Returns comma-separated chat metadata over a given time period for all queues. The date contained within the URI is the start date for the time period. You may optionally specify an end date. The default is to return a day's worth of chat metadata.

The header for the comma-separated values looks like: id, guest, protocol, queue, profile, started, wait, duration, operator, ip, referrer. Each entry post-header contains the metadata described above for each chat.

Optional parameters

You may GET using the following parameters:

Parameters Description
format If set to "csv", then a CSV file named "chats.csv" containing the chats metadata will be returned. JSON is also available by setting format to "json".
to String of the format "YYYY-MM-DD" which specifies the end date for the request. If not specified, the end date is the same as the start date; thus a day's worth of chats are returned.
timezone String containing a time zone to use for chat time stamps. Read more about time zones within .

Example

GET /2011-12-03/conversations/2012/04/04

id,guest,protocol,queue,profile,started,wait,duration,operator,ip,referrer
1782651,7713623961333597129713471@libraryh3lp.com,web,queue1,profile1,2012-04-04T23:38:50.561834-04:00,13,352,operator1,11.22.333.444,https://yourcompany.com
1782557,23267992401333593401869343@libraryh3lp.com,web,queue2,profile3,2012-04-04T22:36:42.458577-04:00,14,385,operator2,77.111.99.222,https://yourcompany.com/features
1782538,23969947901333592679285428@libraryh3lp.com,web,queue2,profile2,2012-04-04T22:24:39.913669-04:00,9,379,operator2,77.22.111.44,https://yourcompany.com/blog
1782504,15554380432,voice,queue1,,2012-04-04T22:11:24.060901-04:00,19,193,operator1,,
1782503,15552570103,voice,queue1,,2012-04-04T22:11:24.032381-04:00,26,0,operator2,,
1782502,15559428995,voice,queue1,,2012-04-04T22:11:23.986896-04:00,,,,,

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.