R Wrapper for LiveChat REST API

Provides a wrapper around LiveChat's API. The R functions allow for one to extract chat sessions, raw text of chats between agents and customers and events.

The package livechatR provides an interface from R to LiveChat's API endpoints (see https://developers.livechatinc.com/rest-api/).

This package contains functions that curl the most frequently used API endpoints (agents, canned responses ahd chats).


  • Authentication by constructing the necessary request URL using the LiveChat's API key and Email.
  • Easy parameterization and result parsing for the following API requests:
    • agents/: get the list of agents using livechatGetAgents.
    • canned_responses/: get the list of canned responses using livechatGetCannedResponses.
    • goals/: get the list of goals using livechatGetGoals.
    • greetings/: get the list of greetings using livechatGetGreetings.
    • chats/: get the list of chat sessions, raw chat text and events using livechatGetChats.




The package depends on

  • dplyr
  • purrr
  • jsonlite
  • data.table
  • magrittr


Set-up connection using LiveChat credentials in R

In order to use the various methods of this package, we need to save the account data of your LiveChat email and API key into a named object using livechatCreateAccount. The next examples all make use of this account object. You can find the API Key and token here.

## Fill in here the API token, key and secret as found on
## https://my.livechatinc.com/agents/api-key
                                  api_key = "api_key_here")

List Agents

> livechatGetAgents(account)

List Canned Responses

> livechatGetCannedResponses(account, group = 0)

List Chat Sessions and Chats

> livechat_data <- livechatGetChats(account, date_from = "2016-02-23")


Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.


0.1.0 by Lawrence Wu, 6 years ago


Browse source code at https://github.com/cran/livechatR

Authors: Lawrence Wu

Documentation:   PDF Manual  

Task views:

GPL-2 license

Imports dplyr, purrr, jsonlite, data.table, magrittr

See at CRAN