Reports: chats per protocol

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/reports/chats-per-protocol

HTTP GET

Returns comma-separated counts of chats per protocol over a given time period and for the desired queues. The header for the comma-separated values is: protocol, chats. Each entry post-header contains the number of chats for the given protocol.

Optional parameters

You may GET the following parameters:

Parameters Description
format If set to "csv", then a CSV file named "chats-per-hour.csv" containing the chats per hour data will be returned.
queues A comma-separated list of queue IDs from which report data should be generated. If not specified, all queues are used by default.
start The start date of the report. Format is YYYY-MM-DD. If not specified, then the start date is the beginning of time.
end The end date of the report. Format is YYYY-MM-DD. If not specified, the end date is today.
sysmsg Boolean. If true, any chats originating from automated systems rather than a person will be included. If null or not specified, chats originating from automated systems will be ignored. This option is particularly handy when running reports on gateway chats.
notanswered Boolean. If true, any chats that were not answered by an operator will be included. If null or not specified, chats that were not answered by an operator will be ignored.
duration An integer number of seconds for the minimum chat duration. Any chats whose duration is less than this value will be ignored. If not provided, chats of any duration will be included.
timezone String containing a time zone to use for chat time stamps. Read more about time zones within LibraryH3lp.

Example

GET /2011-12-03/reports/chats-per-protocol

protocol,chats
web,30452
xmpp,973
aim,263
yahoo,219
gtalk,131
jabber,100
twilio,92
msn,21
voice,16

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.