{"info":{"_postman_id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","name":"LiveChat REST API","description":"

Introduction

Welcome to the LiveChat API documentation!

Our API provides a set of flexible tools which you can use to create new outstanding projects. We smile a bit more each time we see skilled developers unleash their creativity!

Please note that this documentation refers to the latest API version: 2.0. If you are looking for the previous version, check out the deprecated API 1.0 documentation.

Basic API usage

All LiveChat API requests start with https://api.livechatinc.com/.

Please note that all LiveChat API requests must use `HTTPS` protocol.

The next segment of the URL path depends on the type of your request. For example, use: https://api.livechatinc.com/agents to get or modify the agents data.

All requests must have `X-API-VERSION` header set to the number of the version that you'd like to use. The most recent version is 2.

Authentication

Two common authentication methods are supported: OAuth 2.0 and API key.

OAuth 2.0

OAuth 2.0 authentication is the recommended way of authenticating to LiveChat API.

It is the most secure way of making API calls. With this flow, you will get access only to some parts of LiveChat account, such as reading agents list. This is more secure than API key flow which has always access to all LiveChat account data.

To start using OAuth 2.0, please read a dedicated Authorization guide.

API key

If you want to build a private app that will run on your own server, you can skip the OAuth 2.0 flow and use the API key. Please note this flow of making API calls is less secure because the API key gives access to all LiveChat account data.

With this authorization method, you will need to include your LiveChat login and API_KEY for each method call. You’ll find the API key in your LiveChat profile.

Authentication to the API occurs via HTTP Basic Auth. Provide your login as the basic auth username and the API_KEY as the password. You must authenticate for all requests.

All API requests must be made over HTTPS.

Data format

The LiveChat API returns the data in the JSON format. Check out the following example.

JSONP

All requests made with HTTP GET are JSONP-enabled. To use JSONP, append callback= and the name of your callback function to the request.

Error handling

The errors are returned using the standard HTTP error code syntax. In general, the codes in the 2xx range indicate success, the codes in the 4xx range indicate an error (incorrect or missing parameters, not authenticated etc.), and the codes in the 5xx range indicate an error with the LiveChat servers. Any additional info is included in the body of the return call, JSON-formatted.

HTTP status codes summary

400 – The request is incorrect, please make sure that the passed arguments are matching the format in the method’s documentation.
401 – Unauthorized. You attempt to authenticate with an invalid username or API key.
404 – Not Found. You attempt to request a resource which doesn’t exist.
500 – Internal Server Error. Something unexpected happened on our end. Please try again or contact our support.

Cross-domain

All cross-domain API requests made by a web browser are denied for security reasons. It means that the browser-based requests are not allowed from 3rd party domains (including localhost).

LiveChat API libraries

All API calls include an API key that can be easily stolen when making a request using a web browser. It means you should use backend languages for API requests. Here is a list of the ready-to-use libraries:

PHP library for LiveChat API, hosted on Github.
node.js library for LiveChat API, hosted on Github.
Ruby library for LiveChat API, hosted on Github.
C# library for LiveChat API, hosted on Github.

External LiveChat API libraries

R library for LiveChat API, hosted on Github.

Did you write your own library and want it listed here? Let us know!

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"758169","collectionId":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","publishedId":"RVnPL46o","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-04-13T11:54:47.000Z"},"item":[{"name":"Agents","item":[{"name":"List all agents","id":"8ffccb5e-6546-cfb1-cc2d-bdc3617a8977","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"url":"https://api.livechatinc.com/agents","description":"

Returns all LiveChat agents list

\n","urlObject":{"protocol":"https","path":["agents"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ffccb5e-6546-cfb1-cc2d-bdc3617a8977"},{"name":"Create a new agent","id":"f46c0ffe-67c5-bf53-9ca5-d4917542e51e","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"login","value":"john@public.com","type":"text"},{"key":"name","value":"John Public","type":"text"}]},"url":"https://api.livechatinc.com/agents","description":"

Creates a new agent in your license.

\n","urlObject":{"protocol":"https","path":["agents"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f46c0ffe-67c5-bf53-9ca5-d4917542e51e"},{"name":"Get a single agent details","id":"7b96b767-891a-763a-408c-6f40e8229b9f","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/agents/john@public.com","description":"

Returns complete details of the agent for the given LOGIN.

\n","urlObject":{"protocol":"https","path":["agents","john@public.com"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7b96b767-891a-763a-408c-6f40e8229b9f"},{"name":"Get a single agent details","id":"0887a88b-f034-1ac5-00a3-40a581bed1e4","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"job_title","value":"Super Support Agent","type":"text"}]},"url":"https://api.livechatinc.com/agents/john@public.com","description":"

Returns complete details of the agent for the given LOGIN.

\n","urlObject":{"protocol":"https","path":["agents","john@public.com"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0887a88b-f034-1ac5-00a3-40a581bed1e4"},{"name":"Remove an agent","id":"f2febdea-61a8-f575-4c06-fe77bd488957","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/agents/john@public.com","description":"

Removes an agent.

Agents

Use this API method to manage your Agents and to get information about their activities.

Available paths {#agents-available-paths}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Methods	Path
`GET`, `POST`	`/agents`
`GET`, `PUT`, `DELETE`	`/agents/<LOGIN>`
`POST`	`/agents/<LOGIN>/reset_api_key`

List all agents

\n
Path
\n

GET https://api.livechatinc.com/agents\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/agents\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

[\n  {\n    \"name\": \"John Doe\",\n    \"permission\": \"owner\",\n    \"avatar\": \"livechat.s3.amazonaws.com/1011121/all/avatars/bdd8924fcbcdbddbeaf60c19b238b0b0.jpg\",\n    \"login\": \"john.doe@mycompany.com\",\n    \"status\": \"accepting chats\"\n  },\n  ...\n]\n

Returns all LiveChat agents list. Optional parameters:

status - returns the agents with one of the following statuses: accepting chats, not accepting chats or offline.

Additional info:

status can be: accepting chats, not accepting chats or offline.
permission can take the following values: owner, administrator, normal.

Get a single agent details

Returns complete details of the agent for the given LOGIN.

\n
Path
\n

GET https://api.livechatinc.com/agents/<LOGIN>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/agents/john.doe@mycompany.com\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"login\": \"john.doe@mycompany.com\",\n  \"name\": \"John Doe\",\n  \"login_status\": \"accepting chats\",\n  \"permission\": \"owner\",\n  \"daily_summary\": 1,\n  \"job_title\": \"Support Agent\",\n  \"avatar\": \"livechat.s3.amazonaws.com/1011121/all/avatars/bdd8924fcbcdbddbeaf60c19b238b0b0.jpg\",\n  \"notifications\": {\n    \"new_visitor\": 1,\n    \"returning_visitor\": 1,\n    \"queued_visitor\": 1,\n    \"visitor_is_typing\": 0,\n    \"new_goal\": 1\n  },\n  \"max_chats_count\": 6,\n  \"groups\": [\n    {\n      \"id\": 1,\n      \"name\": \"Sales\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Technical Support\"\n    }\n  ],\n  \"status\": \"accepting chats\",\n  \"last_logout\": 1358427204,\n  \"api_key\": \"6ed8580f2cc160ce98d16389a0ede2c0\"\n}\n

Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`login`	the agent's e-mail address
`name`	the agent's name
`login_status`	possible values: `accepting chats`, `not accepting chats`; defines the default status for an agent right after the login
`permission`	possible values: `owner`, `administrator`, `normal`
`daily_summary`	whether or not the agent receives a daily summary
`job_title`	defaults to: `Support Agent`
`avatar`	path to the image on Amazon s3
`notifications`	whether or not the specific notification is enabled
`max_chats_count`	limit of the concurrent chats
`groups[]`	list of groups the agent is a member of
`status`	possible values: `accepting chats`, `not accepting chats`, `offline`; current status of an agent
`last_logout`	timestamp of the agent's last logout
`api_key`	the agent's API key (note: agents can access their own API keys only)

Create a new agent

\n
Path
\n

POST https://api.livechatinc.com/agents\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/agents\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -d \"login=jenny.doe@mycompany.com&\\\nname=Jenny+Doe&\\\npermission=administrator&\\\ngroups[]=1&\\\ngroups[]=2&\\\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/agents\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n        \"login\":\"jenny.doe@mycompany.com\",\n        \"name\":\"Jenny Doe\",\n        \"permission\":\"administrator\",\n        \"groups\":[1,2]\n     }'\n

\n
Sample response
\n

{\n  \"login\": \"jenny.doe@mycompany.com\",\n  \"name\": \"Jenny Doe\",\n  \"login_status\": \"accepting chats\",\n  \"permission\": \"administrator\",\n  \"daily_summary\": 1,\n  \"job_title\": \"Support Agent\",\n  \"avatar\": \"livechat.s3.amazonaws.com/default/avatars/45bcb5f592dbf5aac8f88dcfd6bc937c.png\",\n  \"notifications\": {\n    \"new_visitor\": 1,\n    \"returning_visitor\": 1,\n    \"queued_visitor\": 1,\n    \"visitor_is_typing\": 0,\n    \"new_goal\": 1\n  },\n  \"max_chats_count\": 6,\n  \"groups\": [\n    {\n      \"id\": 1,\n      \"name\": \"Sales\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Technical Support\"\n    }\n  ],\n  \"status\": \"offline\",\n  \"last_logout\": 0,\n  \"api_key\": \"441e519f755db8a51a4e232a31fe6249\"\n}\n

Creates a new agent in your license.

Required properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`login`	must be a correct e-mail address
`name`	string

Optional properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`job_title`	defaults to: `Support Agent`
`login_status`	possible values: `accepting chats`, `not accepting chats`; defines the default status for an agent right after the login
`password`	the minimum length is 5 (if not provided, an email with the activation link will be sent)
`permission`	`administrator`, `normal` (default)
`groups[]`	list of group IDs
`notifications`	object (required keys: `new_visitor`, `incoming_chat`, `returning_visitor`, `queued_visitor`, `visitor_is_typing`, `new_goal`, accepted values: `0` or `1`)
`daily_summary`	`0` or `1` (default)
`max_chats_count`	defaults to `6`

Update an agent

\n
Path
\n

PUT https://api.livechatinc.com/agents/<LOGIN>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/agents/jenny.doe@mycompany.com\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X PUT \\\n  -d \"status=not+accepting+chats&\\\nmax_chats_count=2\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/agents/jenny.doe@mycompany.com\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -X PUT \\\n  -d '{\n        \"status\":\"not accepting chats\",\n        \"max_chats_count\":2\n     }'\n

\n
Sample response
\n

{\n  \"login\": \"jenny.doe@mycompany.com\",\n  \"name\": \"Jenny Doe\",\n  \"login_status\": \"not accepting chats\",\n  \"permission\": \"administrator\",\n  \"daily_summary\": 1,\n  \"job_title\": \"Support Agent\",\n  \"avatar\": \"livechat.s3.amazonaws.com/default/avatars/45bcb5f592dbf5aac8f88dcfd6bc937c.png\",\n  \"notifications\": {\n    \"new_visitor\": 1,\n    \"returning_visitor\": 1,\n    \"queued_visitor\": 1,\n    \"visitor_is_typing\": 0,\n    \"new_goal\": 1\n  },\n  \"max_chats_count\": 2,\n  \"work_scheduler\":{\n    \"sunday\":{\n      \"enabled\":0,\n      \"start\":\"11:00\",\n      \"end\":\"17:00\"\n    },\n    \"monday\":{\n      \"enabled\":1,\n      \"start\":\"09:00\",\n      \"end\":\"17:00\"\n    },\n    ...\n    \"saturday\":{\n      \"enabled\":0,\n      \"start\":\"09:00\",\n      \"end\":\"17:00\"\n    }\n  },\n  \"groups\": [\n    {\n      \"id\": 1,\n      \"name\": \"Sales\"\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Technical Support\"\n    }\n  ],\n  \"status\": \"not accepting chats\",\n  \"last_logout\": 0,\n  \"api_key\": \"441e519f755db8a51a4e232a31fe6249\",\n}\n

Updates the specified agent by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Optional properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`job_title`
`name`
`login_status`	possible values: `accepting chats`, `not accepting chats`; defines the default status for agent right after login
`password`	the password you want to change
`current_password`	when changing the password for yourself or for another agent, you need to provide your current password
`permission`	`administrator`, `normal` (default)
`status`	`accepting chats`, `not accepting chats`, `offline`
`groups[]`	list of group IDs
`notifications`	object (allowed keys: `new_visitor`, `returning_visitor`, `queued_visitor`, `visitor_is_typing`, allowed values: `0` or `1`)
`daily_summary`	`0` or `1`
`max_chats_count`
`work_scheduler`	available only for enterprise plan

The properties which an agent can edit in their own profile, without being an administrator:

password
name
job_title
daily_summary
notifications
login_status
status

Reset an API key

Resets the API key for an agent with a given LOGIN.

\n
Path
\n

POST https://api.livechatinc.com/agents/<LOGIN>/reset_api_key\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/agents/jenny.doe@mycompany.com/reset_api_key\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X POST\n

\n
Sample response
\n

\n
The return format is the same as in the update an agent method.
\n

Remove an agent

Removes an agent. Archived chats will not be removed, but all statistics will be lost. The agent will be notified by e-mail that the account has been deleted.

\n
Path
\n

DELETE https://api.livechatinc.com/agents/<LOGIN>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/agents/jenny.doe@mycompany.com\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X DELETE\n

\n
Sample response
\n

{\n  \"result\": \"jenny.doe@mycompany.com removed successfully\"\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"70da0d11-93bd-4bfc-aebf-27a9663aca51","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e3e4d94c-2985-4208-981a-9bec6a8f1dda","type":"text/javascript","exec":[""]}}],"_postman_id":"b729bcba-d4b8-c5d1-0e57-ab9ff36fce10","auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":true,"source":{"_postman_id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","name":"LiveChat REST API","type":"collection"}}},{"name":"Archives","item":[{"name":"Get list of chats","id":"c3c1aa7b-f2e2-b4b7-c1e1-1d3b2b357363","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/chats","description":"

Returns all ended chats.

\n","urlObject":{"protocol":"https","path":["chats"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3c1aa7b-f2e2-b4b7-c1e1-1d3b2b357363"},{"name":"Get single chat","id":"645736f5-6dfb-2a40-2356-3829063b0b27","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/chats/ABC123","description":"

Returns a single chat item for the given CHAT_ID.

\n","urlObject":{"protocol":"https","path":["chats","ABC123"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"645736f5-6dfb-2a40-2356-3829063b0b27"},{"name":"Send chat transcript to e-mail","id":"3ff20f94-71d6-089e-ebbc-19b5fd4bd558","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/chats/ABC123/send_transcript","urlObject":{"protocol":"https","path":["chats","ABC123","send_transcript"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ff20f94-71d6-089e-ebbc-19b5fd4bd558"},{"name":"Update chat tags","id":"a804f3fa-69df-3119-fcfe-f54eee05ba1f","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"tag[0]","value":"support","type":"text"},{"key":"tag[1]","value":"feedback","type":"text"}]},"url":"https://api.livechatinc.com/chats/ABC123/tags","description":"

This method updates the tags assigned to a chat.

\n","urlObject":{"protocol":"https","path":["chats","ABC123","tags"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a804f3fa-69df-3119-fcfe-f54eee05ba1f"}],"id":"4fe4578b-9386-3f31-7dd7-19887d49bb37","description":"

Methods	Path
`GET`	`/chats`
`GET`	`/chats/<CHAT_ID>`
`POST`	`/chats/<CHAT_ID>/send_transcript`
`PUT`	`/chats/<CHAT_ID>/tags`

Parameter	Description
`date_from`	`YYYY-MM-DD` Defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD` Defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`page`	page number, defaults to 1
`visitor_id`	return chats with specified visitor_id
`query`	return chats containing the query
`agent`	return chats for given agent login
`group`	return chats for given group id
`goal`	return chats for given goal id
`has_goal`	`1/0`. If 1 is passed, returns chats having any goal
`sale`	return chats for given sales tracker id
`has_sale`	`1/0`. If 1 is passed, returns chats having any tracked sale
`queued`	`1/0`. If 1 is passed, returns chats started from queue
`rate`	filter chats considering its rating status. Available values: `rated`, `not_rated`, `rated_good`, `rated_bad`
`include_pending`	`1/0`. Whether to include chats that haven't yet ended. Pending chats can be recognized by `pending: true` attribute
`tag[]`	filter chats by a specified tag
`tagged`	`1/0`. If 1 is passed, chats with any tag are returned. If 0 is passed, only chats without a tag are returned
`comment`	`1/0`. If 1 is passed, chats with rating comments are returned
`city`	filters by city, values should be entered and are returned in the local language
`region`	filters by region. This could be a state, voivodeship, canton, county etc. Values should be entered and are returned in the local language
`country`	filters by country name. All values are in english

Parameter	Description
`goal`	parameter will appear only if a goal has been reached or there was tracked sale for a particular chat
`referrer`	parameter will appear only if referrer url exists
`custom_variables`	parameter will be available only if the custom variables are defined in the tracking code
`integration_variables`	parameter will appear only if a visitor logs in with Facebook
`queue`	parameter will appear only if chat started from queue
`engagement`	– possible values: `auto_invite` (chat from automatic invitation), `manual_invite` (chat from manual invitation), `immediate_start` (visitor started chats themselves)
`duration`	is counted in seconds
`total`	tells you the total number of chats
`pages`	tells you the total number of pages
`city`, `region`, `country`	geolocation filters have been working for chats since May 11, 2015

Parameter	Description
`to`	receiver's email address.

Canned responses

Use this method to get a full list of your Canned responses and to modify them.

Available paths {#canned-responses-available-paths}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Methods	Path
`GET`, `POST`	`/canned_responses`
`GET`, `PUT`, `POST`	`/canned_responses/<CANNED_RESPONSE_ID>`

List all canned responses

\n
Path
\n

GET https://api.livechatinc.com/canned_responses\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/canned_responses?group=1\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

[\n  {\n    \"id\": 3151,\n    \"group\": 1,\n    \"text\": \"Can I help you with anything else?\",\n    \"creation_date\": 1358257181,\n    \"created_by\": \"john.doe@mycompany.com\",\n    \"tags\": [\n      \"help\",\n      \"else\"\n    ]\n  },\n  {\n    \"id\": 3161,\n    \"group\": 1,\n    \"text\": \"What product are you interested in?\",\n    \"creation_date\": 1358257229,\n    \"created_by\": \"john.doe@mycompany.com\",\n    \"modification_date\": 1358864338,\n    \"modified_by\": \"jenny.doe@mycompany.com\",\n    \"tags\": [\n      \"product\",\n      \"interest\"\n    ]\n  },\n  {\n      \"...\": \"...\"\n  }\n]\n

Returns the list of all currently set canned responses.

Optional parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`group`	defaults to `0`
`modification_date`, `modification_by`	appear if the canned response has been modified

Get a single canned response

CANNED_RESPONSE_ID is obtained from the list of all canned responses.

\n
Path
\n

GET https://api.livechatinc.com/canned_responses/<CANNED_RESPONSE_ID>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/canned_responses/3151\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"id\": 3151,\n  \"group\": 1,\n  \"text\": \"Can I help you with anything else?\",\n  \"creation_date\": 1358257181,\n  \"created_by\": \"john.doe@mycompany.com\",\n  \"tags\": [\n    \"help\",\n    \"else\"\n  ]\n}\n

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	id of the canned response
`group`	id of the group that canned response is assigned to
`text`	canned response text
`creation_date`	creation date timestamp
`created_by`	login of the canned response's author
`tags`	an array of canned response's tags

Create a new canned response

\n
Path
\n

POST https://api.livechatinc.com/canned_responses\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/canned_responses\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -d \"text=Have+a+great+day,+goodbye.&\\\ntags[]=bye&\\\ntags[]=cu\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/canned_responses\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n        \"text\":\"Have a great day, goodbye.\",\n        \"tags\": [\"bye\", \"cu\"]\n     }'\n

\n
Sample response
\n

{\n  \"id\": 3181,\n  \"group\": 0,\n  \"text\": \"Have a great day, goodbye.\",\n  \"creation_date\": 1358866421,\n  \"created_by\": \"john.doe@mycompany.com\",\n  \"tags\": [\n    \"cu\",\n    \"bye\"\n  ]\n}\n

Creates a new canned response.

Required properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`text`	response text
`tags`	array of strings (tags)

Optional properties

\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`group`	defaults to 0

Update a canned response

\n
Path
\n

PUT https://api.livechatinc.com/canned_responses/<CANNED_RESPONSE_ID>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/canned_responses/3181\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X PUT -d \"tags[]=bye\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/canned_responses\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -X PUT \\\n  -d '{\n        \"tags\": [\"bye\"]\n     }'\n

\n
Sample response
\n

{\n  \"id\": 3181,\n  \"group\": 0,\n  \"text\": \"Have a great day, goodbye.\",\n  \"creation_date\": 1358866421,\n  \"created_by\": \"john.doe@mycompany.com\",\n  \"modification_date\": 1358866813,\n  \"modified_by\": \"john.doe@mycompany.com\",\n  \"tags\": [\n    \"bye\"\n  ]\n}\n

Updates the specified canned response by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Optional properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`text`	response text
`tags`	array of strings (tags)

Remove a canned response

\n
Path
\n

DELETE https://api.livechatinc.com/canned_responses/<CANNED_RESPONSE_ID>\n

\n
Example request
\n

curl \"https://api.livechatinc.com/canned_responses/3181\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X DELETE\n

\n
Example response
\n

{\n  \"result\": \"Canned response removed successfully\"\n}\n

Removes a canned response with the given CANNED_RESPONSE_ID.

\n","event":[{"listen":"prerequest","script":{"id":"202f0c28-737a-4bc4-8ac7-4d6669770192","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9ac436b6-ac2b-45fd-b813-586e209faa62","type":"text/javascript","exec":[""]}}],"_postman_id":"dae92d5d-47aa-2b83-caa6-ddad1402fed5","auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":true,"source":{"_postman_id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","name":"LiveChat REST API","type":"collection"}}},{"name":"Goals","item":[{"name":"List all goals","id":"32f368ab-3679-88f6-65f1-7ebdfe8bba6a","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/goals","description":"

Returns all currently set goals. The active parameter indicates whether a goal is enabled or not.

\n","urlObject":{"protocol":"https","path":["goals"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"32f368ab-3679-88f6-65f1-7ebdfe8bba6a"},{"name":"Get a single goal details","id":"972d435b-4e6e-e539-44ab-1790a4760033","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/goals/ABC123","description":"

Returns the goal details for the given GOAL_ID.

\n","urlObject":{"protocol":"https","path":["goals","ABC123"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"972d435b-4e6e-e539-44ab-1790a4760033"},{"name":"Mark a goal as successful","id":"dba8bc5f-ea34-2df9-dd85-c1ee2113647d","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"visitor_id","value":"ABC123","type":"text"}]},"url":"https://api.livechatinc.com/goals/ABC123/mark_as_successful","description":"

The GOAL_ID is obtained from the goals list.

\n","urlObject":{"protocol":"https","path":["goals","ABC123","mark_as_successful"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dba8bc5f-ea34-2df9-dd85-c1ee2113647d"},{"name":"Add a new goal","id":"b98ef115-2f7f-e0aa-2c2e-b22637f884cf","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"new_goal","type":"text"},{"key":"type","value":"url","type":"text"},{"key":"url","value":"http://www.mystore.com/checkout/thank_you","type":"text"},{"key":"match_type","value":"exact","type":"text"}]},"url":"https://api.livechatinc.com/goals","description":"

Creates a new goal.

\n","urlObject":{"protocol":"https","path":["goals"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b98ef115-2f7f-e0aa-2c2e-b22637f884cf"},{"name":"Update a goal","id":"4788a21a-ae2b-fea2-f34f-57f1905a4bc3","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"new_goal","type":"text"},{"key":"active","value":"0","type":"text"}]},"url":"https://api.livechatinc.com/goals/ABC123","description":"

Updates the specified goal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

The GOAL_ID is obtained from the goals list.

\n","urlObject":{"protocol":"https","path":["goals","ABC123"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4788a21a-ae2b-fea2-f34f-57f1905a4bc3"},{"name":"Remove a goal","id":"ea3f3313-1b0a-c5c3-7f13-7fd7b65d1fd6","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/goals/ABC123","description":"

Removes a goal with the given GOAL_ID.

\n","urlObject":{"protocol":"https","path":["goals","ABC123"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea3f3313-1b0a-c5c3-7f13-7fd7b65d1fd6"},{"name":"Remove a group","id":"b8197ddd-ebdf-2d0b-2ba4-f54cd599ee05","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/groups/ABC123","description":"

Removes a group with the given GROUP_ID.

Goals

This method allows you to get information about your Goals and to modify them.

Available paths {#goals-available-paths}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Methods	Path
`GET`, `POST`	`/goals`
`GET`, `PUT`, `DELETE`	`/goals/<GOAL_ID>`
`POST`	`/goals/<GOAL_ID>/mark_as_successful`

List all goals

\n
Path
\n

GET https://api.livechatinc.com/goals\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/goals\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

[\n  {\n    \"id\": 1041,\n    \"name\": \"purchase\",\n    \"active\": 1\n  },\n  {\n    \"id\": 1181,\n    \"name\": \"nike shoes variable\",\n    \"active\": 1\n  }\n]\n

Returns all currently set goals. The active parameter indicates whether a goal is enabled or not.

Get a single goal details

\n
Path
\n

GET https://api.livechatinc.com/goals/<GOAL_ID>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/goals/1181\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"id\": 1181,\n  \"name\": \"nike shoes variable\",\n  \"active\": 1,\n  \"type\": \"custom_variable\",\n  \"custom_variable_name\": \"nike_shoes\",\n  \"custom_variable_value\": \"true\"\n}\n

Returns the goal details for the given GOAL_ID.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	id of the goal
`name`	goal name
`active`	whether or not the goal is enabled
`type`	type of the goal

Additional info

The type attribute can take the following values:

custom_variable – with two additional parameters: custom_variable_name, custom_variable_value.
url – with two additional parameters: url and match_type with possible values: substring (default), exact.
api – with no additional parameters.

Mark a goal as successful

\n
Path
\n

POST https://api.livechatinc.com/goals/<GOAL_ID>/mark_as_successful\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/goals/1181/mark_as_successful\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -d \"visitor_id=S1281361958.2238ee3bd3\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/goals/1181/mark_as_successful\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n        \"visitor_id\":\"S1281361958.2238ee3bd3\",\n     }'\n

\n
Sample response
\n

{\n  \"result\": \"goal marked as successful\"\n}\n

The GOAL_ID is obtained from the goals list.

Required parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`visitor_id`	obtained using the JavaScript API: LC_API.get_visitor_id()

Optionally you can store additional information about the goal. They can be only retrieved using the API.

Optional parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Example
`order_id`	`AP723HVCA721`
`order_description`	`Nike shoes`
`order_price`	`199.00`, only the period is allowed as a separation character
`order_currency`	`USD`

Add a new goal

\n
Path
\n

POST https://api.livechatinc.com/goals\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/goals\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-VERSION:2 \\\n  -d \"name=new%20goal&\\\n  type=url&\\\n  url=http://www.mystore.com/checkout/thank_you&\\\n  match_type=exact\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/goals\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n        \"name\":\"new goal\",\n        \"type\":\"url\",\n        \"url\":\"http://www.mystore.com/checkout/thank_you\",\n        \"match_type\":\"exact\"\n     }'\n

\n
Sample response
\n

{\n  \"id\": 2231,\n  \"name\": \"new goal\",\n  \"active\": 1,\n  \"type\": \"url\",\n  \"match_type\": \"exact\",\n  \"url\": \"http://www.mystore.com/checkout/thank_you\"\n}\n

Creates a new goal.

Required parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`name`
`type`

Additional info

The type can take the following values:

custom_variable – with two additional parameters: custom_variable_name, custom_variable_value. Both are required.
url – with two additional parameters: url (required) and match_type (optional) with possible values: substring (default), exact.
api – with no additional parameters.

The active parameter indicates whether the goal is active or not.

Update a goal

\n
Path
\n

PUT https://api.livechatinc.com/goals/<GOAL_ID>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/goals/2231\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X PUT -d \"name=new%20goal%20paused&\\\n  active=0\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/goals/2231\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n        \"name\":\"new goal paused\",\n        \"active\":0\n     }'\n

\n
Sample response
\n

{\n  \"id\": 2231,\n  \"name\": \"new goal paused\",\n  \"active\": 0,\n  \"type\": \"url\",\n  \"match_type\": \"exact\",\n  \"url\": \"http://www.mystore.com/checkout/thank_you\"\n}\n

Updates the specified goal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

The GOAL_ID is obtained from the goals list.

Optional parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`name`
`type`

Additional info

The type can take the following values:

custom_variable – with two additional parameters: custom_variable_name, custom_variable_value. Both are required.
url – with two additional parameters: url (required) and match_type (optional) with possible values: substring (default), exact.
api – with no additional parameters.

The active parameter indicates whether the goal is active or not.

Remove a goal

\n
Path
\n

DELETE https://api.livechatinc.com/goals/<GOAL_ID>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/goals/2231\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X DELETE\n

\n
Sample response
\n

{\n  \"result\": \"goal removed successfully\"\n}\n

Removes a goal with the given GOAL_ID.

\n","event":[{"listen":"prerequest","script":{"id":"dbb3df06-9cd9-4b2c-a811-654a4b73a9a5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"af4ffb99-df0e-442c-86d6-23d818eb4282","type":"text/javascript","exec":[""]}}],"_postman_id":"12f9b67a-c8a4-0fda-094f-85a57f9ee8a1","auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":true,"source":{"_postman_id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","name":"LiveChat REST API","type":"collection"}}},{"name":"Greetings","item":[{"name":"List all greetings","id":"6839632d-528f-9324-e93d-7d00f9b7854d","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/greetings?groups=ABC123","description":"

Returns the list of all greetings.

\n","urlObject":{"protocol":"https","path":["greetings"],"host":["api","livechatinc","com"],"query":[{"key":"groups","value":"ABC123"}],"variable":[]}},"response":[],"_postman_id":"6839632d-528f-9324-e93d-7d00f9b7854d"},{"name":"Get a single greeting","id":"073a5a2a-db11-3a19-ba24-206d4df61a18","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/greetings/ABC123","description":"

Returns the specified greeting.

\n","urlObject":{"protocol":"https","path":["greetings","ABC123"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"073a5a2a-db11-3a19-ba24-206d4df61a18"},{"name":"Create a new greeting","id":"8a012b3e-8ca7-f2d1-120a-8bc110fe1777","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"my custom invitation","type":"text"},{"key":"rules[0][type]","value":"visit_time_page","type":"text"},{"key":"rules[0][value]","value":"15","type":"text"},{"key":"rules[0][operator]","value":"greater_than","type":"text"},{"key":"rules[1][type]","value":"visits_number","type":"text"},{"key":"rules[1][value]","value":"2","type":"text"},{"key":"rules[1][operator]","value":"greater_or_equal","type":"text"}]},"url":"https://api.livechatinc.com/greetings","description":"

Use this function to create a new greeting.

\n","urlObject":{"protocol":"https","path":["greetings"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a012b3e-8ca7-f2d1-120a-8bc110fe1777"},{"name":"Update greeting","id":"9a294828-9c45-cf70-6e39-6ea0bd26f193","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"athletic shoes","type":"text"},{"key":"properties[greeting-message_text]","value":"Hello","type":"text"}]},"url":"https://api.livechatinc.com/greetings/2491","description":"

Use this request to change the name or message of a greeting.

\n","urlObject":{"protocol":"https","path":["greetings","2491"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9a294828-9c45-cf70-6e39-6ea0bd26f193"},{"name":"Remove a greeting","id":"97df5b12-555f-d1e5-dda2-8f8f94e4ed0b","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/greetings/ABC123","description":"

Removes a greeting.

Greetings

You can use this method to create new and modify the existing Greetings. It can be also used to look up Greetings data.

Available paths {#greetings-available-paths}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Methods	Path
`GET`, `POST`	`/greetings`
`GET`, `POST`, `DELETE`	`/greetings/<GREETING_ID>`

List all greetings

\n
Path
\n

GET -H X-API-Version:2 https://api.livechatinc.com/greetings\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/greetings\\\n  ?group=1\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

[\n  {\n    \"id\": 2291,\n    \"active\": true,\n    \"name\": \"Time on site: 5 sec\",\n    \"rules\": [\n      {\n        \"id\": 8201,\n        \"value\": \"5\",\n        \"type\": \"visit_time_site\",\n        \"operator\": \"equals\",\n        \"condition\": \"and\"\n      }\n    ],\n    \"properties\": {\n      \"active\": \"1\",\n      \"greeting-message_text\": \"Hello, how may I help you?\"\n    }\n  },\n  {\n    \"id\": 2411,\n    \"active\": true,\n    \"name\": \"Returning visitor\",\n    \"rules\": [\n      {\n        \"id\": 8191,\n        \"value\": \"2\",\n        \"type\": \"visits_number\",\n        \"operator\": \"greater_or_equal\",\n        \"condition\": \"and\"\n      }\n    ],\n    \"properties\": {\n      \"active\": \"1\",\n      \"greeting-message_text\": \"Hello again!\"\n    }\n  }\n]\n

Returns the list of all greetings.

Optional properties

\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`group`	Group number can be specified to get greetings from a given group. If not specified, all greetings will be returned

Get a single greeting

\n
Path
\n

GET -H X-API-Version:2 https://api.livechatinc.com/greetings/<GREETING_ID>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/greetings/2411\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample result
\n

{\n  \"id\": 2411,\n  \"active\": true,\n  \"name\": \"Returning visitor\",\n  \"rules\": [\n    {\n      \"id\": 8191,\n      \"value\": \"2\",\n      \"type\": \"visits_number\",\n      \"operator\": \"greater_or_equal\",\n      \"condition\": \"and\"\n    }\n  ],\n  \"properties\": {\n    \"active\": \"1\",\n    \"greeting-message_text\": \"Hello again!\"\n  }\n}\n

Returns the specified greeting.

Additional info:

active – Indicates whether the greeting is enabled or not
rules – Returns an array with all the rules for the specified greeting

Create a new greeting

\n
Path
\n

[POST] /greetings\n

Use this function to create a new greeting.

Required properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`name`	greeting name displayed in the LiveChat settings (not visible to your website's visitors)
`rules`	an array of conditions that must be met for the greeting to be displayed. Greeting rules are documented below

Optional properties

\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`group`	creates a greeting displayed in a particular group only. Defaults to `0`

Greeting rules

\n
Sample request
\n

curl \"https://api.livechatinc.com/greetings\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -d \"name=my+custom+invitation&\\\nrules[0][type]=visit_time_page&\\\nrules[0][value]=15&\\\nrules[0][operator]=greater_than&\\\nrules[1][type]=visits_number&\\\nrules[1][value]=2&\\\nrules[1][operator]=greater_or_equal\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/greetings\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n        \"name\":\"my custom invitation\",\n        \"rules\":[\n          {\n            \"type\":\"visit_time_page\",\n            \"value\":15,\n            \"operator\":\"greater_than\"\n          },\n          {\n            \"type\":\"visits_number\",\n            \"value\":2,\n            \"operator\":\"greater_or_equal\"\n          }\n        ]\n      }'\n

\n
Sample result
\n

{\n  \"id\": 2451,\n  \"active\": true,\n  \"name\": \"my custom invitation\",\n  \"rules\": [\n    {\n      \"id\": 8241,\n      \"value\": \"2\",\n      \"type\": \"visits_number\",\n      \"operator\": \"greater_or_equal\",\n      \"condition\": \"and\"\n    },\n    {\n      \"id\": 8251,\n      \"value\": \"15\",\n      \"type\": \"visit_time_page\",\n      \"operator\": \"greater_than\",\n      \"condition\": \"and\"\n    }\n  ],\n  \"properties\": {\n    \"active\": \"1\",\n    \"greeting-message_text\": \"Hello, would you like to talk about our products?\"\n  }\n}\n

Greeting rules are the conditions that must be met for a greeting to be displayed.

Each greeting rule can contain an operator. Here's a list of possible operators:

equals,
doesnt_equal,
lower_than,
lower_or_equal,
greater_than,
greater_or_equal,
contains,
doesnt_contain.

The default value for operator is equals.

And here's a list of the greeting rules that you can use:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Rule	Description
`visit_time_site`	After a visitor has spent a certain amount of time on the site
`visit_time_page`	After a visitor has spent a certain amount of time on a page
`url_current`	For the visitors on specific pages
`url_visited`	When a visitor has visited specific pages
`pages_view_number`	For the visitors who have seen a page for a number of times
`url_referrer`	When the visitor has arrived from a referring page
`geolocation`	For the visitors from specific countries or cities
`visits_number`	For the returning visitors
`search_keyword`	When a visitor has searched for a specific keyword
`custom_variable`	The greeting will be sent when the specified variable is met documented below
`url_funnel`	The visitors who visit the specified sequence of websites will receive the greeting documented below

Custom variable

\n
Sample request
\n

curl \"https://api.livechatinc.com/greetings\\\n  ?group=1\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -d \"name=custom+variable+type+greeting&\\\nrules[0][type]=custom_variable&\\\nrules[0][variable_name]=my_custom_var&\\\nrules[0][variable_value]=var_value&\\\nrules[0][operator]=contains\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/greetings\\\n  ?group=1\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n        \"name\":\"custom variable type greeting\",\n        \"rules\":[\n          {\n            \"type\":\"custom_variable\",\n            \"variable_name\":\"my_custom_var\",\n            \"variable_value\":\"var_value\"\n            \"operator\":\"contains\"\n          }\n        ]\n      }'\n

\n
Sample result
\n

{\n  \"id\": 2431,\n  \"active\": true,\n  \"name\": \"custom variable type greeting\",\n  \"rules\": [\n    {\n      \"id\": 8221,\n      \"type\": \"custom_variable\",\n      \"operator\": \"contains\",\n      \"condition\": \"and\",\n      \"variable_name\": \"my_custom_var\",\n      \"variable_value\": \"var_value\"\n    }\n  ],\n  \"properties\": {\n    \"active\": \"1\",\n    \"greeting-message_text\": \"Hello, would you like to talk about our products?\"\n  }\n}\n

The greeting will be sent when the specified variable is met.

\n\n\n\n\n

URL Funnel

\n
Sample request
\n

curl \"https://api.livechatinc.com/greetings\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -d \"name=url+funnel+type+greeting&\\\nrules[0][type]=url_funnel&\\\nrules[0][urls][0][url]=mystore.com/shoes&\\\nrules[0][urls][0][operator]=equals&\\\nrules[0][urls][1][url]=cart&\\\nrules[0][urls][1][operator]=contains\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/greetings\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n        \"name\":\"url funnel type greeting\",\n        \"rules\":[\n          {\n            \"type\":\"url_funnel\",\n            \"urls\":[\n              {\n                \"url\":\"mystore.com/shoes\",\n                \"operator\":\"equals\"\n              },\n              {\n                \"url\":\"cart\",\n                \"operator\":\"contains\"\n              }\n            ]\n          }\n        ]\n      }'\n

\n
Sample result
\n

{\n  \"id\": 2441,\n  \"active\": true,\n  \"name\": \"url funnel type greeting\",\n  \"rules\": [\n    {\n      \"id\": 8231,\n      \"type\": \"url_funnel\",\n      \"condition\": \"and\",\n      \"urls\": [\n        {\n          \"url\": \"mystore.com/shoes\",\n          \"operator\": \"equals\"\n        },\n        {\n          \"url\": \"cart\",\n          \"operator\": \"contains\"\n        }\n      ]\n    }\n  ],\n  \"properties\": {\n    \"active\": \"1\",\n    \"greeting-message_text\": \"Hello, would you like to talk about our products?\"\n  }\n}\n

The visitors who have visited the specified sequence of pages will receive the greeting.

\n\n\n

Greetings with multiple rules

\n
Sample request
\n

curl \"https://api.livechatinc.com/greetings\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -d \"name=my+custom+invitation&\\\nrules[0][type]=visit_time_site&\\\nrules[0][value]=15&\\\nrules[1][type]=custom_variable&\\\nrules[1][variable_name]=empty_cart&\\\nrules[1][variable_value]=true&\\\nrules[2][type]=url_current&\\\nrules[2][value]=shoes&\\\nrules[2][operator]=contains\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/greetings\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n        \"name\":\"my custom invitation\",\n        \"rules\":[\n          {\n            \"type\":\"visit_time_site\",\n            \"value\":15\n          },\n          {\n            \"type\":\"custom\",\n            \"variable_name\":\"empty_cart\",\n            \"variable_value\":true\n          },\n          {\n            \"type\":\"url_current\",\n            \"value\":\"shoes\",\n            \"operator\":\"contains\"\n          }\n        ]\n      }'\n

\n
Sample result
\n

{\n  \"id\": 2471,\n  \"active\": true,\n  \"name\": \"my custom invitation\",\n  \"rules\": [\n    {\n      \"id\": 8261,\n      \"type\": \"custom_variable\",\n      \"operator\": \"equals\",\n      \"condition\": \"and\",\n      \"variable_name\": \"empty_cart\",\n      \"variable_value\": \"true\"\n    },\n    {\n      \"id\": 8271,\n      \"value\": \"15\",\n      \"type\": \"visit_time_site\",\n      \"operator\": \"equals\",\n      \"condition\": \"and\"\n    },\n    {\n      \"id\": 8281,\n      \"value\": \"shoes\",\n      \"type\": \"url_current\",\n      \"operator\": \"contains\",\n      \"condition\": \"and\"\n    }\n  ],\n  \"properties\": {\n    \"active\": \"1\",\n    \"greeting-message_text\": \"Hello, would you like to talk about our products?\"\n  }\n}\n

You can create a greeting that will have more than one rule.

Update a greeting

\n
Path
\n

PUT -H X-API-Version:2 -d \"...\" \"https://api.livechatinc.com/greetings/<GREETING_ID>\"\n

You can change the previously created greetings using this request. The GREETING_ID is obtained from the list of all greetings.

Update greeting name or message

\n
Sample request
\n

curl \"https://api.livechatinc.com/greetings/2491\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X PUT -d \"name=athletic+shoes&\\\nproperties[greeting-message_text]=Hello\"\n

Use this request to change the name or message of a greeting.

Activate and deactivate greetings

\n
Sample request
\n

curl \"https://api.livechatinc.com/greetings/2491\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X PUT -d \"active=0\"\n

Activate or deactivate a greeting using this request.

Change greetings rules

\n
Sample request
\n

curl \"https://api.livechatinc.com/greetings/2491\"\\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X PUT -d \"rules[0][type]=custom_variable&\\\nrules[0][variable_name]=athletic_shoes&\\\nrules[0][variable_value]=true\" \n

\n
Sample result
\n

{\n  \"id\": 2491,\n  \"active\": false,\n  \"name\": \"athletic shoes\",\n  \"rules\": [\n    {\n      \"id\": 8371,\n      \"type\": \"custom_variable\",\n      \"operator\": \"equals\",\n      \"condition\": \"and\",\n      \"variable_name\": \"athletic_shoes\",\n      \"variable_value\": \"true\"\n    }\n  ],\n  \"properties\": {\n    \"active\": \"0\",\n    \"greeting-message_text\": \"Hi, are you looking for some athletic shoes\"\n  }\n}\n

Change the rules of your greetings with this request.

Remove a greeting

\n
Path
\n

DELETE https://api.livechatinc.com/greetings/<GREETING_ID>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/greetings/2491\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X DELETE\n

\n
Sample response
\n

{\n  \"ok\": true\n}\n

Removes a greeting.

\n","event":[{"listen":"prerequest","script":{"id":"5f3fc636-6f72-40c1-a559-5aa472b12c27","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d248288d-75de-4acb-bac2-d7aacf20a254","type":"text/javascript","exec":[""]}}],"_postman_id":"712b3ffe-2e16-1c2e-ad35-d9e6301c8052","auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":true,"source":{"_postman_id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","name":"LiveChat REST API","type":"collection"}}},{"name":"Groups","item":[{"name":"List all groups","id":"d9762536-29d1-dfac-bb23-8498761c55e8","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/groups","description":"

Returns all created groups.

\n","urlObject":{"protocol":"https","path":["groups"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d9762536-29d1-dfac-bb23-8498761c55e8"},{"name":"Get a single group details","id":"8ce98ef0-c0cc-ac52-723c-e2021f67024d","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/groups/{{group_id}}","description":"

Returns group details for the given GROUP_ID.

\n","urlObject":{"protocol":"https","path":["groups","{{group_id}}"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ce98ef0-c0cc-ac52-723c-e2021f67024d"},{"name":"Create a new group","id":"d284b657-be36-be02-6262-4ad5c94338ec","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Human Resources","type":"text"},{"key":"agents[0]","value":"jenny.doe@mycompany.com","type":"text"},{"key":"agents[1]","value":"john.doe@mycompany.com","type":"text"}]},"url":"https://api.livechatinc.com/groups","description":"

Creates a new group in your license.

\n","urlObject":{"protocol":"https","path":["groups"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d284b657-be36-be02-6262-4ad5c94338ec"},{"name":"Update a group","id":"f28c7e69-b861-ce90-6dec-5459ea8cbbcb","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"PUT","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Quality+Assurance","type":"text"},{"key":"agents[0]","value":"john.doe@mycompany.com","type":"text"},{"key":"agents[1]","value":"jane.doe@mycompany.com","type":"text"}]},"url":"https://api.livechatinc.com/groups/ABC123","description":"

Updates the specified group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

\n","urlObject":{"protocol":"https","path":["groups","ABC123"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f28c7e69-b861-ce90-6dec-5459ea8cbbcb"},{"name":"Remove a group","id":"983187af-c701-ef34-7672-0c56775c02fd","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/groups/ABC123","description":"

Removes a group with the given GROUP_ID.

Groups

Use this method to get Agent Groups data and also to create new and modify the existing Groups.

Available paths {#groups-available-paths}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Methods	Path
`GET`, `POST`	`/groups`
`GET`, `PUT`, `DELETE`	`/groups/<GROUP_ID>`

List all groups

\n
Path
\n

GET https://api.livechatinc.com/groups\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/groups\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

[\n  {\n    \"id\": 0,\n    \"name\": \"All operators\",\n    \"language\": \"en\",\n    \"status\": \"accepting chats\"\n  },\n  {\n    \"id\": 1,\n    \"name\": \"Invoicing\",\n    \"language\": \"en\",\n    \"agents\": [\n      \"jane.doe@mycompany.com\"\n    ],\n    \"status\": \"offline\"\n  },\n  {\n    \"id\": 2,\n    \"name\": \"Sales\",\n    \"language\": \"en\",\n    \"agents\": [\n      \"john.doe@mycompany.com\",\n      \"jenny.doe@mycompany.com\"\n    ],\n    \"status\": \"not accepting chats\"\n  },\n  {\n    \"id\": 3,\n    \"name\": \"Technical Support\",\n    \"language\": \"en\",\n    \"agents\": [\n      \"john.doe@mycompany.com\"\n    ],\n    \"status\": \"accepting chats\"\n  }\n]\n

Returns all created groups.

Additional info:

language specifies the chat window language for the particular group.
agents list contains all members of the particular group. The group with id 0 doesn't return the agents list because it always contains all agents from the license and it cannot be modified.

Get a single group details

\n
Path
\n

GET https://api.livechatinc.com/groups/<GROUP_ID>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/groups/2\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"id\": 2,\n  \"name\": \"Sales\",\n  \"language\": \"en\",\n  \"agents\": [\n    \"john.doe@mycompany.com\",\n    \"jenny.doe@mycompany.com\"\n  ],\n  \"status\": \"accepting chats\"\n}\n   \n

Returns group details for the given GROUP_ID.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	id of the group
`name`	group name
`language`	group language (defaults to English). See the list of supported languages
`agents`	an array of group members' logins
`status`	current status of the group

Additional info:

The status can take the following values:

accepting chats – when at least one agent from the group is logged in and has the accepting chats status.
not accepting chats – when at least one agent from the group is logged in but has the not accepting chats status.
offline – when all agents from the group are offline.

Create a new group

\n
Path
\n

POST https://api.livechatinc.com/groups\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/groups\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -d \"name=Human+Resources&\\\nagents[0]=jenny.doe@mycompany.com&\\\nagents[1]=john.doe@mycompany.com\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/groups\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n       \"name\":\"Human Resources\",\n       \"agents[0]\":\"jenny.doe@mycompany.com\",\n       \"agents[1]\":\"john.doe@mycompany.com\" \n      }'  \n

\n
Sample response
\n

{\n  \"id\": 4,\n  \"name\": \"Human Resources\",\n  \"language\": \"en\",\n  \"agents\": [\n    \"jenny.doe@mycompany.com\",\n    \"john.doe@mycompany.com\"\n  ],\n  \"status\": \"offline\"\n}\n   \n

Creates a new group in your license.

Required properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`name`	group name
`agents`	an array of LiveChat users' logins (e-mails)

Optional properties

\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`language`	group language (defaults to English). See the list of supported languages

Update a group

\n
Path
\n

PUT https://api.livechatinc.com/groups/<GROUP_ID>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/groups/3\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X PUT \\\n  -d \"name=Quality+Assurance&\\\nagents[0]=john.doe@mycompany.com&\\\nagents[1]=jane.doe@mycompany.com\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/groups/3\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 -X PUT \\   \n  -H Content-type:application/json \\\n  -d '{\n        \"name\"=\"Quality Assurance\",\n        \"agents[0]\":\"john.doe@mycompany.com\",\n        \"agents[1]\":\"jane.doe@mycompany.com\"\n      }'\n

\n
Sample response
\n

{\n  \"id\": 3,\n  \"name\": \"Quality Assurance\",\n  \"language\": \"en\",\n  \"agents\": [\n    \"john.doe@mycompany.com\",\n    \"jane.doe@mycompany.com\"\n  ],\n  \"status\": \"offline\"\n }\n   \n

Updates the specified group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Optional properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`name`	group name
`language`	see the list of supported languages
`agents`	an array of LiveChat users' logins (e-mails)

Remove a group

\n
Path
\n

DELETE https://api.livechatinc.com/groups/<GROUP_ID>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/groups/4\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X DELETE\n

\n
Sample response
\n

{\n  \"result\": \"group removed successfully\"\n}\n   \n

Removes a group with the given GROUP_ID.

\n","event":[{"listen":"prerequest","script":{"id":"05c0e34d-fa58-4f11-b378-9355165934bb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"897a62e2-eee5-41d9-b623-9e09bb44e1fe","type":"text/javascript","exec":[""]}}],"_postman_id":"1d4192aa-9511-4c02-8d28-26503498a69b","auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":true,"source":{"_postman_id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","name":"LiveChat REST API","type":"collection"}}},{"name":"Reports","item":[{"name":"Chat engagement","id":"6d6a1178-439f-3ee3-1bb5-61dc17259b4b","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/chats/engagement?date_from=2013-01-29&date_to=2013-01-29&agent=john.doe@mycompany.com&group_by=hour","description":"

This report shows you where you get your chats from. They can come from i.e. automatic invitations, manual invitations or the visitors can start the chats by themselves.

\n","urlObject":{"protocol":"https","path":["reports","chats","engagement"],"host":["api","livechatinc","com"],"query":[{"key":"date_from","value":"2013-01-29"},{"key":"date_to","value":"2013-01-29"},{"key":"agent","value":"john.doe@mycompany.com"},{"key":"group_by","value":"hour"}],"variable":[]}},"response":[],"_postman_id":"6d6a1178-439f-3ee3-1bb5-61dc17259b4b"},{"name":"Total chats","id":"a626222b-f75d-47dc-cda9-ec8f8e8969b5","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/chats/total_chats?date_from=2013-01-29&date_to=2013-01-29&agent=john.doe@mycompany.com&group_by=hour","description":"

Shows how many chats occurred during the specified period.

\n","urlObject":{"protocol":"https","path":["reports","chats","total_chats"],"host":["api","livechatinc","com"],"query":[{"key":"date_from","value":"2013-01-29"},{"key":"date_to","value":"2013-01-29"},{"key":"agent","value":"john.doe@mycompany.com"},{"key":"group_by","value":"hour"}],"variable":[]}},"response":[],"_postman_id":"a626222b-f75d-47dc-cda9-ec8f8e8969b5"},{"name":"Chat ratings report","id":"66a1fca0-f266-16af-395c-a301c64ecbbe","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/chats/ratings?group=2&date_from=2012-01-29&date_to=2013-01-29&group_by=month","description":"

Shows how many chats have been rated and how they have been rated during a specified period.

\n","urlObject":{"protocol":"https","path":["reports","chats","ratings"],"host":["api","livechatinc","com"],"query":[{"key":"group","value":"2"},{"key":"date_from","value":"2012-01-29"},{"key":"date_to","value":"2013-01-29"},{"key":"group_by","value":"month"}],"variable":[]}},"response":[],"_postman_id":"66a1fca0-f266-16af-395c-a301c64ecbbe"},{"name":"Chat Ranking","id":"3589e755-3ec5-6dda-6016-de82b9a92821","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/chats/ratings/ranking","description":"

Shows the ratio of good to bad ratings for each operator.

\n","urlObject":{"protocol":"https","path":["reports","chats","ratings","ranking"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3589e755-3ec5-6dda-6016-de82b9a92821"},{"name":"Queued visitors","id":"c8bd3c4d-e238-a00d-9182-8fa07f9ddaf7","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/chats/queued_visitors?date_from=2013-01-29&group=2","description":"

Shows how many visitors waited in the queue and how many abandoned the queue or proceeded to chats

\n","urlObject":{"protocol":"https","path":["reports","chats","queued_visitors"],"host":["api","livechatinc","com"],"query":[{"key":"date_from","value":"2013-01-29"},{"key":"group","value":"2"}],"variable":[]}},"response":[],"_postman_id":"c8bd3c4d-e238-a00d-9182-8fa07f9ddaf7"},{"name":"Queue waiting times","id":"f9c28fbc-f7ff-e065-2a61-8776a7504ff2","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/chats/queued_visitors/waiting_times?date_from=2013-01-29&group=2","description":"

Shows the Minimum, Average and Maximum waiting time.

\n","urlObject":{"protocol":"https","path":["reports","chats","queued_visitors","waiting_times"],"host":["api","livechatinc","com"],"query":[{"key":"date_from","value":"2013-01-29"},{"key":"group","value":"2"}],"variable":[]}},"response":[],"_postman_id":"f9c28fbc-f7ff-e065-2a61-8776a7504ff2"},{"name":"Availability","id":"bb2cda46-3d8e-da49-7875-69a337069422","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/availability","description":"

Shows how long an agent (or a group or the whole account) was available for chatting during a specified period. When querying for one day, the results are shown in minutes per every hour, otherwise in hours for each day.

\n","urlObject":{"protocol":"https","path":["reports","availability"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb2cda46-3d8e-da49-7875-69a337069422"},{"name":"Chatting time","id":"bc0c95cb-d3bc-c70f-c65c-ee06670e19f3","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/chats/chatting_time","description":"

Shows how much time an agent (or a group) spent on chatting during a specified period. When querying for one day, the results are shown in minutes per every hour, otherwise in hours for each day.

\n","urlObject":{"protocol":"https","path":["reports","chats","chatting_time"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc0c95cb-d3bc-c70f-c65c-ee06670e19f3"},{"name":"Chats first response time","id":"222cb87c-f1e1-bab2-4960-aa4476f3e50f","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/chats/first_response_time","description":"

The average amount of time it takes the agents to respond to a new chat over a specified period of time.

\n","urlObject":{"protocol":"https","path":["reports","chats","first_response_time"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"222cb87c-f1e1-bab2-4960-aa4476f3e50f"},{"name":"Chats response time","id":"6383811f-ee1c-e277-25cf-39ce2f9d5e91","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/chats/response_time","description":"

The average amount of time it takes the agents to respond to a new message in a chat during a specified period.

\n","urlObject":{"protocol":"https","path":["reports","chats","response_time"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6383811f-ee1c-e277-25cf-39ce2f9d5e91"},{"name":"Number of simultaneous chats","id":"6de49fb6-98ea-a56a-3b2f-c225e838ffd4","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/chats/agents_occupancy?weekday=mon","description":"

This request shows the maximum number of concurrent chats that happened at the same hour on a particular day.

\n","urlObject":{"protocol":"https","path":["reports","chats","agents_occupancy"],"host":["api","livechatinc","com"],"query":[{"key":"weekday","value":"mon"}],"variable":[]}},"response":[],"_postman_id":"6de49fb6-98ea-a56a-3b2f-c225e838ffd4"},{"name":"Goals","id":"26e4bcad-dc13-b1fb-6f5b-83c39789f8c1","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/chats/goals?date_from=2013-01-01&goal=71&group_by=month","description":"

Shows the number of reached goals.

\n","urlObject":{"protocol":"https","path":["reports","chats","goals"],"host":["api","livechatinc","com"],"query":[{"key":"date_from","value":"2013-01-01"},{"key":"goal","value":"71"},{"key":"group_by","value":"month"}],"variable":[]}},"response":[],"_postman_id":"26e4bcad-dc13-b1fb-6f5b-83c39789f8c1"},{"name":"Greetings","id":"fd0ac7a0-6a31-8fc4-5575-e243e55f0e89","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/chats/greetings?date_from=2014-01-13&date_to=2014-02-14&group_by=month","description":"

Returns the “greetings to chats to goals” conversion rates report.

displayed is the number of displayed greetings. accepted tells you how many chats resulted from these greetings. goals tells you how many goals resulted from these greetings.

\n","urlObject":{"protocol":"https","path":["reports","chats","greetings"],"host":["api","livechatinc","com"],"query":[{"key":"date_from","value":"2014-01-13"},{"key":"date_to","value":"2014-02-14"},{"key":"group_by","value":"month"}],"variable":[]}},"response":[],"_postman_id":"fd0ac7a0-6a31-8fc4-5575-e243e55f0e89"},{"name":"New tickets","id":"c6d4c562-17ed-ab05-72c7-5e561c58edca","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/tickets/new_tickets?date_from=2013-01-29&date_to=2013-01-29&group_by=hour","description":"

Shows the number of the tickets created during the specified period.

\n","urlObject":{"protocol":"https","path":["reports","tickets","new_tickets"],"host":["api","livechatinc","com"],"query":[{"key":"date_from","value":"2013-01-29"},{"key":"date_to","value":"2013-01-29"},{"key":"group_by","value":"hour"}],"variable":[]}},"response":[],"_postman_id":"c6d4c562-17ed-ab05-72c7-5e561c58edca"},{"name":"Tickets first response time","id":"cd10bdb8-9153-5277-ce6b-8706a5b82524","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/tickets/first_response_time?date_from=2014-01-10&date_to=2014-01-20&agent=john.doe@mycompany.com","description":"

Shows the time of the first response to the tickets that were responded to for the first time during the specified period.

\n","urlObject":{"protocol":"https","path":["reports","tickets","first_response_time"],"host":["api","livechatinc","com"],"query":[{"key":"date_from","value":"2014-01-10"},{"key":"date_to","value":"2014-01-20"},{"key":"agent","value":"john.doe@mycompany.com"}],"variable":[]}},"response":[],"_postman_id":"cd10bdb8-9153-5277-ce6b-8706a5b82524"},{"name":"Solved tickets","id":"119255c0-1bbb-6b2a-1cba-89753edace85","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/tickets/solved_tickets?date_from=2014-01-10&date_to=2014-01-20","description":"

Shows the number of the tickets solved during the specified period.

\n","urlObject":{"protocol":"https","path":["reports","tickets","solved_tickets"],"host":["api","livechatinc","com"],"query":[{"key":"date_from","value":"2014-01-10"},{"key":"date_to","value":"2014-01-20"}],"variable":[]}},"response":[],"_postman_id":"119255c0-1bbb-6b2a-1cba-89753edace85"},{"name":"Tickets resolution time","id":"7235920e-f5a4-f8b1-443b-d0fd2f6b9f0e","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/tickets/resolution_time?date_from=2014-01-10&date_to=2014-01-20","description":"

Shows the resolution time of the tickets that were solved during the specified period.

\n","urlObject":{"protocol":"https","path":["reports","tickets","resolution_time"],"host":["api","livechatinc","com"],"query":[{"key":"date_from","value":"2014-01-10"},{"key":"date_to","value":"2014-01-20"}],"variable":[]}},"response":[],"_postman_id":"7235920e-f5a4-f8b1-443b-d0fd2f6b9f0e"},{"name":"Ticket sources","id":"fc7ba8cd-aa75-0cfe-e1fa-be43e75c45d9","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/tickets/ticket_sources?date_from=2014-01-10&date_to=2014-01-20","description":"

Shows the distribution of the tickets between various channels.

\n","urlObject":{"protocol":"https","path":["reports","tickets","ticket_sources"],"host":["api","livechatinc","com"],"query":[{"key":"date_from","value":"2014-01-10"},{"key":"date_to","value":"2014-01-20"}],"variable":[]}},"response":[],"_postman_id":"fc7ba8cd-aa75-0cfe-e1fa-be43e75c45d9"},{"name":"Ticket ratings report","id":"f36af221-2ccf-1db1-46f7-f1b93b4de1bc","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/tickets/ratings?group=2&date_from=2012-01-29&date_to=2013-01-29&group_by=month","description":"

Shows the tickets that were rated during the specified period.

\n","urlObject":{"protocol":"https","path":["reports","tickets","ratings"],"host":["api","livechatinc","com"],"query":[{"key":"group","value":"2"},{"key":"date_from","value":"2012-01-29"},{"key":"date_to","value":"2013-01-29"},{"key":"group_by","value":"month"}],"variable":[]}},"response":[],"_postman_id":"f36af221-2ccf-1db1-46f7-f1b93b4de1bc"},{"name":"Ticket Ranking","id":"46532c7c-0e67-0705-7190-6f2c870844aa","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/reports/tickets/ratings/ranking","description":"

Shows the ratio of good to bad ratings for each operator.

\n","urlObject":{"protocol":"https","path":["reports","tickets","ratings","ranking"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"46532c7c-0e67-0705-7190-6f2c870844aa"}],"id":"8e6a7cdb-4af1-4715-762d-b14ea757896d","description":"

Reports

This method allows you to access and extract all the Reports data available in LiveChat.

Available paths {#reports-available-paths}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Methods	Path
`GET`	`/reports/chats/total_chats`
`GET`	`/reports/chats/engagement`
`GET`	`/reports/chats/ratings`
`GET`	`/reports/chats/ratings/ranking`
`GET`	`/reports/chats/queued_visitors`
`GET`	`/reports/chats/queued_visitors/waiting_times`
`GET`	`/reports/availability`
`GET`	`/reports/chats/chatting_time`
`GET`	`/reports/chats/first_response_time`
`GET`	`/reports/chats/response_time`
`GET`	`/reports/chats/goals`
`GET`	`/reports/chats/greetings`
`GET`	`/reports/tickets/new_tickets`
`GET`	`/reports/tickets/first_response_time`
`GET`	`/reports/tickets/solved_tickets`
`GET`	`/reports/tickets/resolution_time`
`GET`	`/reports/tickets/ticket_sources`
`GET`	`/reports/tickets/ratings`
`GET`	`/reports/tickets/ratings/ranking`

Total chats

\n
Path
\n

GET https://api.livechatinc.com/reports/chats/total_chats\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/chats/total_chats?\\\ndate_from=2013-01-29&\\\ndate_to=2013-01-29&\\\nagent=john.doe@mycompany.com&\\\ngroup_by=hour\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"00:00\": {\n    \"chats\": 18\n  },\n  \"01:00\": {\n    \"chats\": 19\n  },\n    \"02:00\": {\n    \"chats\": 6\n  },\n    \"03:00\": {\n      \"chats\": 15\n  },\n  \"04:00\": {\n    \"chats\": 10\n  },\n  \"05:00\": {\n    \"chats\": 14\n  },\n  \"06:00\": {\n    \"chats\": 11\n  },\n  //(...)\n  \"21:00\": {\n    \"chats\": 0\n  },\n  \"22:00\": {\n    \"chats\": 0\n  },\n  \"23:00\": {\n    \"chats\": 2\n  }\n}\n

Shows how many chats occurred during the specified period.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`group`	id of the group, not set by default, returns statistics for the specified group
`agent`	agent's login, not set by default, return statistics for the specified agent
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

Chat engagement

\n
Path
\n

GET https://api.livechatinc.com/reports/chats/engagement\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/chats/engagement?\\\ndate_from=2013-01-28&\\\ndate_to=2013-01-29&\\\nagent=john.doe@mycompany.com&\\\ntag[]=sales&\\\ngroup_by=hour\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2013-01-28\":{\n    \"chats_from_auto_invite\":1,\n    \"chats_from_immediate_start\":0,\n    \"chats_from_manual_invite\":3\n  },\n  \"2013-01-29\":{\n    \"chats_from_auto_invite\":0,\n    \"chats_from_immediate_start\":2,\n    \"chats_from_manual_invite\":0\n  }\n}\n

This report shows you where you get your chats from. They can come from i.e. automatic invitations, manual invitations or the visitors can start the chats by themselves.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`group`	id of the group, not set by default, returns statistics for the specified group
`agent`	agent's login, not set by default, return statistics for the specified agent
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

Chat ratings report

\n
Path
\n

GET https://api.livechatinc.com/reports/chats/ratings\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/chats/ratings?\\\ngroup=2&\\\ndate_from=2012-01-29&\\\ndate_to=2013-01-29&\\\ngroup_by=month\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2012-01\": {\n    \"begin\": \"2012-01-29\",\n    \"end\": \"2012-01-31\",\n    \"bad\": 0,\n    \"good\": 6,\n    \"chats\": 37\n  },\n  \"2012-02\": {\n    \"begin\": \"2012-02-01\",\n    \"end\": \"2012-02-29\",\n    \"bad\": 4,\n    \"good\": 38,\n    \"chats\": 320\n  },\n  \"2012-03\": {\n    \"begin\": \"2012-03-01\",\n    \"end\": \"2012-03-31\",\n    \"bad\": 0,\n    \"good\": 16,\n    \"chats\": 186\n  },\n  //(...) \n  \"2012-11\": {\n    \"begin\": \"2012-11-01\",\n    \"end\": \"2012-11-30\",\n    \"bad\": 20,\n    \"good\": 49,\n    \"chats\": 389\n  }\n}\n

Shows how many chats have been rated and how they have been rated during a specified period.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`group`	id of the group, not set by default, returns statistics for the specified group
`agent`	agent's login, not set by default, return statistics for the specified agent
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

Chat Ranking

\n
Path
\n

GET https://api.livechatinc.com/reports/chats/ratings/ranking\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/chats/ratings/ranking\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"ranking\": [\n    {\n      \"good\": 2502,\n      \"bad\": 426,\n      \"total\": 2928,\n      \"score\": 0.8361489669658251,\n      \"name\": \"john.doe@mycompany.com\"\n    },\n    {\n      \"good\": 2164,\n      \"bad\": 443,\n      \"total\": 2607,\n      \"score\": 0.8094273999034496,\n      \"name\": \"jane.doe@mycompany.com\"\n    },\n    {\n      \"good\": 1070,\n      \"bad\": 215,\n      \"total\": 1285,\n      \"score\": 0.8029689181922964,\n      \"name\": \"jenny.doe@mycompany.com\"\n    }\n}\n

Shows the ratio of good to bad ratings for each operator.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`group`	id of the group, not set by default, returns statistics for the specified group
`tag[]`	return statistics for the specified tag

Queued visitors

\n
Path
\n

GET https://api.livechatinc.com/reports/chats/queued_visitors\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/chats/queued_visitors?\\\ndate_from=2013-01-29&\\\ngroup=2\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2013-01-29\": {\n    \"queued\": {\n      \"count\": 6,\n    },\n    \"left_queue\": {\n      \"count\": 3,\n    },\n    \"entered_chat\": {\n      \"count\": 3,\n    }\n  },\n  \"2013-01-30\": {\n    \"queued\": {\n      \"count\": 2,\n    },\n    \"left_queue\": {\n      \"count\": 0\n    },\n    \"entered_chat\": {\n      \"count\": 2,\n    }\n  }\n}\n

Shows how many visitors waited in the queue and how many abandoned the queue or proceeded to chats.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`group`	id of the group, not set by default, returns statistics for the specified group
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`

Queue waiting times

\n
Path
\n

GET https://api.livechatinc.com/reports/chats/queued_visitors/waiting_times\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/chats/queued_visitors/waiting_times?\\\ndate_from=2013-01-29&\\\ngroup=2\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2013-01-29\":{\n    \"queued\":{\n      \"count\": 1,\n      \"min\":{\n        \"seconds\":0\n      },\n      \"max\":{\n        \"seconds\":112\n      },\n      \"average\":{\n        \"seconds\":24\n      }\n    },\n    \"left_queue\":{\n      \"count\": 3,\n      \"min\":{\n        \"seconds\":33\n      },\n      \"max\":{\n        \"seconds\":56\n      },\n      \"average\":{\n        \"seconds\":44\n      }\n    },\n    \"entered_chat\":{\n      \"count\": 2,\n      \"min\":{\n        \"seconds\":10\n      },\n      \"max\":{\n        \"seconds\":112\n      },\n      \"average\":{\n        \"seconds\":23\n      }\n    }\n  }\n}\n

Shows the Minimum, Average and Maximum waiting time.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`group`	id of the group, not set by default, returns statistics for the specified group
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`

Availability

\n
Path
\n

GET https://api.livechatinc.com/reports/availability\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/availability?\\\ndate_from=2013-01-25&\\\ndate_to=2013-01-30&\\\nagent=john.doe@mycompany.com&\\\ngroup_by=day\"\\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2013-01-25\": {\n    \"hours\": 0\n  },\n  \"2013-01-26\": {\n    \"hours\": 0\n  },\n  \"2013-01-27\": {\n    \"hours\": 0.01\n  },\n  \"2013-01-28\": {\n    \"hours\": 7.85\n  },\n  \"2013-01-29\": {\n    \"hours\": 7.99\n  },\n  \"2013-01-30\": {\n    \"hours\": 2.28\n  }\n}\n

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`group`	id of the group, not set by default, returns statistics for the specified group
`agent`	agent's login, not set by default, return statistics for the specified agent

Chatting time

\n
Path
\n

GET https://api.livechatinc.com/reports/chats/chatting_time\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/chats/chatting_time?\\\ndate_from=2013-01-25&\\\ndate_to=2013-01-30&\\\ngroup=1\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2013-01-25\": {\n    \"hours\": 8.17\n  },\n  \"2013-01-26\": {\n    \"hours\": 9.2\n  },\n  \"2013-01-27\": {\n    \"hours\": 5.3\n  },\n  \"2013-01-28\": {\n    \"hours\": 7.16\n  },\n  \"2013-01-29\": {\n    \"hours\": 10.71\n  },\n  \"2013-01-30\": {\n    \"hours\": 6.51\n  }\n}\n

Shows how much time an agent (or a group) spent on chatting during a specified period. When querying for one day, the results are shown in minutes per every hour, otherwise in hours for each day.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`group`	id of the group, not set by default, returns statistics for the specified group
`agent`	agent's login, not set by default, returns statistics for the specified agent
`tag[]`	return statistics for the specified tag

Chats first response time

\n
Path
\n

GET https://api.livechatinc.com/reports/chats/first_response_time\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/chats/first_response_time?\\\ndate_from=2014-01-10&\\\ndate_to=2014-01-20&\\\nagent=john.doe@mycompany.com\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2014-01-10\": {\n    \"first_response_time\": {\n      \"count\": 5,\n      \"seconds\": 0.83\n    }\n  },\n  \"2014-01-11\": {\n    \"first_response_time\": {\n      \"count\": 1,\n      \"seconds\": 1.3\n    }\n  },\n  //(...)\n  \"2014-01-20\": {\n    \"first_response_time\":{\n      \"count\": 0,\n      \"seconds\": null\n    }\n  }\n}\n

The average amount of time it takes the agents to respond to a new chat over a specified period of time.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`group`	id of the group, not set by default, returns statistics for the specified group
`agent`	agent's login, not set by default, return statistics for the specified agent
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

The following parameters are returned for each date:

count – the number of chat first responses during the specified period.
seconds – the average first response time.

Chats response time

\n
Path
\n

GET https://api.livechatinc.com/reports/chats/response_time\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/chats/response_time?\\\ndate_from=2014-01-10&\\\ndate_to=2014-01-20&\\\nagent=john.doe@mycompany.com\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2014-01-10\": {\n    \"avg_response_time\": {\n      \"count\": 5,\n      \"seconds\": 0.83\n    }\n  },\n  \"2014-01-11\": {\n    \"avg_response_time\": {\n      \"count\": 1,\n      \"seconds\": 1.3\n    }\n  },\n  //(...)\n  \"2014-01-20\": {\n    \"avg_response_time\":{\n      \"count\": 0,\n      \"seconds\": null\n    }\n  }\n}\n

The average amount of time it takes the agents to respond to a new message in a chat during a specified period.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`group`	id of the group, not set by default, returns statistics for the specified group
`agent`	agent's login, not set by default, return statistics for the specified agent
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

The following parameters are returned for each date:

count – the number of chat responses during the specified period.
seconds – the average response time

Number of simultaneous chats

\n
Path
\n

GET https://api.livechatinc.com/reports/chats/agents_occupancy\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/chats/agents_occupancy?\\\nweekday=mon\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n    \"2015-03-16 00:00\": 0,\n    \"2015-03-16 01:00\": 0,\n    \"2015-03-16 02:00\": 0,\n    \"2015-03-16 03:00\": 0,\n    \"2015-03-16 04:00\": 0,\n    \"2015-03-16 05:00\": 0,\n    \"2015-03-16 06:00\": 0,\n    \"2015-03-16 07:00\": 0,\n    \"2015-03-16 08:00\": 0,\n    \"2015-03-16 09:00\": 13,\n    \"2015-03-16 10:00\": 17,\n    \"2015-03-16 11:00\": 20,\n    \"2015-03-16 12:00\": 20,\n    \"2015-03-16 13:00\": 16,\n    \"2015-03-16 14:00\": 16,\n    \"...\": \"...\",\n    \"2015-03-23 00:00\": 0,\n    \"2015-03-23 01:00\": 0,\n    \"2015-03-23 02:00\": 0,\n    \"2015-03-23 03:00\": 0,\n    \"2015-03-23 04:00\": 0,\n    ...\n    \"2015-04-06 23:00\": 0\n}\n

This request shows the maximum number of concurrent chats that happened at the same hour on a particular day.

Required arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`weekday`	you can select the day by changing the weekday parameter to one of the following values: `mon` for Monday, `tue` for Tuesday, `wed` for Wednesday, `thu` for Thursday, `fri` for Friday, `sat` for saturday and `sun` for Sunday

Goals {#reports-goals}

\n
Path
\n

GET https://api.livechatinc.com/reports/chats/goals\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/chats/goals?\\\ndate_from=2013-01-01&\\\ngoal=71&group_by=month\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2013-01\": {\n    \"begin\": \"2013-01-01\",\n    \"end\": \"2013-01-30\",\n    \"goals\": 4\n  }\n}\n

Shows the number of reached goals.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`group`	id of the group, not set by default, returns statistics for the specified group
`goal`	id of the goal, not set by default
`agent`	agent's login, not set by default, return statistics for the specified agent
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

Greetings {#reports-greetings}

\n
Path
\n

GET https://api.livechatinc.com/reports/chats/greetings\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/chats/greetings?\\\ndate_from=2014-01-13&\\\ndate_to=2014-02-14&\\\ngroup_by=month\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2014-01\": {\n    \"begin\": \"2014-01-13\",\n    \"end\": \"2014-01-31\",\n    \"displayed\": 274,\n    \"accepted\": 190,\n    \"goals\": 40\n  },\n  \"2014-02\": {\n  \"begin\": \"2014-02-01\",\n    \"end\": \"2014-02-14\",\n    \"displayed\": 146,\n    \"accepted\": 88,\n    \"goals\": 22\n  }\n}\n

Returns the “greetings to chats to goals” conversion rates report.

displayed is the number of displayed greetings. accepted tells you how many chats resulted from these greetings. goals tells you how many goals resulted from these greetings.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`group`	id of the group, not set by default, returns statistics for the specified group
`goal`	id of the goal, not set by default
`greeting`	`id` of the greeting, not set by default, returns statistics for the specified greeting
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

New tickets

\n
Path
\n

GET https://api.livechatinc.com/reports/tickets/new_tickets\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/tickets/new_tickets?\\\ndate_from=2013-01-29&\\\ndate_to=2013-01-29&\\\ngroup_by=hour\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"00:00\": {\n    \"new_tickets\": 5\n  },\n  \"01:00\": {\n    \"new_tickets\": 1\n  },\n  //(...)\n  \"23:00\": {\n    \"new_tickets\": 21\n  }\n}\n

Shows the number of the tickets created during the specified period.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`group`	id of the group, not set by default, returns statistics for the specified group
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

Tickets first response time

\n
Path
\n

GET https://api.livechatinc.com/reports/tickets/first_response_time\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/tickets/first_response_time?\\\ndate_from=2014-01-10&\\\ndate_to=2014-01-20&\\\nagent=john.doe@mycompany.com\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2014-01-10\": {\n    \"count\": 5,\n    \"hours\": 0.83\n  },\n  \"2014-01-11\": {\n    \"count\": 1,\n    \"hours\": 1.3\n  },\n  //(...)\n  \"2014-01-20\": {\n    \"count\": 0,\n    \"hours\": null\n  }\n}\n

Shows the time of the first response to the tickets that were responded to for the first time during the specified period.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`agent`	agent's login, not set by default, return statistics for the specified agent
`group`	id of the group, not set by default, returns statistics for the specified group
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

The following parameters are returned for each date:

count – the number of tickets that were responded to for the first time that day.
hours – average first response time of the tickets. For example, \"hours\": 0.83 means an average first response time of 49mins 48sec.

Solved tickets

\n
Path
\n

GET https://api.livechatinc.com/reports/tickets/solved_tickets\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/tickets/solved_tickets?\\\ndate_from=2014-01-10&\\\ndate_to=2014-01-20\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2014-01-10\": {\n    \"solved_tickets\": 4\n  },\n  \"2014-01-11\": {\n    \"solved_tickets\": 12\n  },\n  //(...)\n  \"2014-01-20\": {\n    \"solved_tickets\": 4\n  }\n}\n

Shows the number of the tickets solved during the specified period.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`agent`	agent's login, not set by default, return statistics for the specified agent
`group`	id of the group, not set by default, returns statistics for the specified group
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

Tickets resolution time

\n
Path
\n

GET https://api.livechatinc.com/reports/tickets/resolution_time\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/tickets/resolution_time?\\\ndate_from=2014-01-10&\\\ndate_to=2014-01-20\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2014-01-10\": {\n    \"count\": 3,\n    \"hours\": 16.27\n  },\n  \"2014-01-11\": {\n    \"count\": 0,\n    \"hours\": null\n  },\n  //(...)\n  \"2014-01-20\": {\n    \"count\": 2,\n    \"hours\": 1.8\n  }\n}\n

Shows the resolution time of the tickets that were solved during the specified period.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`agent`	agent's login, not set by default, return statistics for the specified agent
`group`	id of the group, not set by default, returns statistics for the specified group
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

Two parameters are returned:

count – the number of tickets that were responded to for the first time that day.
hours – the average first response time of the tickets. For example, \"hours\": 0.83 means an average first response time of 49mins 48sec.

Ticket sources

\n
Path
\n

GET https://api.livechatinc.com/reports/tickets/ticket_sources\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/tickets/ticket_sources?\\\ndate_from=2014-01-10&\\\ndate_to=2014-01-20\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2014-01-10\": {\n    \"tickets_from_chat_window\": 4,\n    \"tickets_from_mail\": 12,\n    \"tickets_from_chat\": 2\n  },\n  \"2014-01-11\": {\n    \"tickets_from_chat_window\": 7,\n    \"tickets_from_mail\": 8,\n    \"tickets_from_chat\": 6\n  },\n  //(...)\n  \"2014-01-20\": {\n    \"tickets_from_chat_window\": 0,\n    \"tickets_from_mail\": 16,\n    \"tickets_from_chat\": 1\n  }\n}\n

Shows the distribution of the tickets between various channels.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`group`	id of the group, not set by default, returns statistics for the specified group
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

The following parameters are returned for each date:

tickets_from_chat_window – the number of tickets created by the visitor via the ticket form,
tickets_from_mail – the number of tickets created by sending an email to your support email tied to LiveChat,
tickets_from_chat – the number of tickets created by the agents during a chat.

Ticket ratings report

\n
Path
\n

GET https://api.livechatinc.com/reports/tickets/ratings\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/tickets/ratings?\\\ngroup=2&\\\ndate_from=2012-01-29&\\\ndate_to=2013-01-29&\\\ngroup_by=month\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"2012-01\": {\n    \"begin\": \"2012-01-29\",\n    \"end\": \"2012-01-31\",\n    \"bad\": 0,\n    \"good\": 6\n  },\n  \"2012-02\": {\n    \"begin\": \"2012-02-01\",\n    \"end\": \"2012-02-29\",\n    \"bad\": 4,\n    \"good\": 38\n  },\n  \"2012-03\": {\n    \"begin\": \"2012-03-01\",\n    \"end\": \"2012-03-31\",\n    \"bad\": 0,\n    \"good\": 16\n  },\n  //(...) \n  \"2012-11\": {\n    \"begin\": \"2012-11-01\",\n    \"end\": \"2012-11-30\",\n    \"bad\": 20,\n    \"good\": 49\n  },\n  \"2012-12\": {\n    \"begin\": \"2012-12-01\",\n    \"end\": \"2012-12-31\",\n    \"bad\": 22,\n    \"good\": 35\n  },\n  \"2013-01\": {\n    \"begin\": \"2013-01-01\",\n    \"end\": \"2013-01-29\",\n    \"bad\": 18,\n    \"good\": 51\n  }\n}\n

Shows the tickets that were rated during the specified period.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`timezone`	timezone in the TZ format (e.g. America/Phoenix)
`agent`	agent's login, not set by default, return statistics for the specified agent
`group`	id of the group, not set by default, returns statistics for the specified group
`group_by`	defaults to `day` (or `hour` when date_from equals date_to), can be set to `month`, `hour` or `day`
`tag[]`	return statistics for the specified tag

Ticket Ranking

\n
Path
\n

GET https://api.livechatinc.com/reports/tickets/ratings/ranking\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/reports/tickets/ratings/ranking\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"ranking\": [\n    {\n      \"good\": 2502,\n      \"bad\": 426,\n      \"total\": 2928,\n      \"score\": 0.8361489669658251,\n      \"name\": \"john.doe@mycompany.com\"\n    },\n    {\n      \"good\": 2164,\n      \"bad\": 443,\n      \"total\": 2607,\n      \"score\": 0.8094273999034496,\n      \"name\": \"jane.doe@mycompany.com\"\n    },\n    {\n      \"good\": 1070,\n      \"bad\": 215,\n      \"total\": 1285,\n      \"score\": 0.8029689181922964,\n      \"name\": \"jenny.doe@mycompany.com\"\n    }\n}\n

Shows the ratio of good to bad ratings for each operator.

Optional arguments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Argument	Description
`date_from`	`YYYY-MM-DD`, defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`, defaults to `today`
`group`	id of the group, not set by default, returns statistics for the specified group
`tag[]`	return statistics for the specified tag

","event":[{"listen":"prerequest","script":{"id":"685e8fd3-e2ca-4a3a-8157-5e75b7e37f3d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"688bee17-5dcd-42b4-b894-c589a292d6a3","type":"text/javascript","exec":[""]}}],"_postman_id":"8e6a7cdb-4af1-4715-762d-b14ea757896d","auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":true,"source":{"_postman_id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","name":"LiveChat REST API","type":"collection"}}},{"name":"Status","item":[{"name":"Get status","id":"ee46edef-22c8-b991-bbc3-77495de9da56","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/status","description":"

Returns the current LiveChat status. Available return values: online, offline.

\n","urlObject":{"protocol":"https","path":["status"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee46edef-22c8-b991-bbc3-77495de9da56"}],"id":"b54bb228-94d9-fe16-de24-7026edcc4154","description":"

Status

You can use this method to check whether your LiveChat is online or offline.

Available paths {#status-available-paths}

\n\n\n\n\n\n\n\n\n\n\n\n\n

Methods	Path
`GET`	`/status`

Get status

\n
Path
\n

GET https://api.livechatinc.com/status\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/status/1\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n  \"status\":\"online\"\n}\n

Returns the current LiveChat status. Available return values: online, offline.

Optional parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`group`	defaults to 0

","event":[{"listen":"prerequest","script":{"id":"3b558439-b452-463f-bd97-4af630a039fa","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c3129ba2-784c-4270-8af1-b67f0d021e10","type":"text/javascript","exec":[""]}}],"_postman_id":"b54bb228-94d9-fe16-de24-7026edcc4154","auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":true,"source":{"_postman_id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","name":"LiveChat REST API","type":"collection"}}},{"name":"Tags","item":[{"name":"List all tags","id":"64923bc0-6952-1e76-f285-5c2897eca3ec","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/tags?group=1","description":"

Returns tags from all groups.

\n","urlObject":{"protocol":"https","path":["tags"],"host":["api","livechatinc","com"],"query":[{"key":"group","value":"1"}],"variable":[]}},"response":[],"_postman_id":"64923bc0-6952-1e76-f285-5c2897eca3ec"},{"name":"Add a tag","id":"bcb98039-a04c-d008-bdf2-bcf2a9f8e932","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"tag","value":"support","type":"text"},{"key":"author","value":"john.doe@mycompany.com","type":"text"},{"key":"group","value":"1","type":"text"}]},"url":"https://api.livechatinc.com/tags","description":"

Adds a new tag. Note that only the owner and the admins are authorized to use this.

\n","urlObject":{"protocol":"https","path":["tags"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bcb98039-a04c-d008-bdf2-bcf2a9f8e932"},{"name":"Delete a tag","id":"070528ef-773f-6621-9a85-1194ea791a02","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"group","value":"1","type":"text"}]},"url":"https://api.livechatinc.com/tags/support","description":"

Deletes a tag from the chosen group. The agents will no longer be able to tag chats and tickets using this tag.

Deleting a tag will not remove it from the archived chats and tickets.

\n","urlObject":{"protocol":"https","path":["tags","support"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"070528ef-773f-6621-9a85-1194ea791a02"}],"id":"72704ab8-ac33-3b27-c8bc-37f63b71dabf","description":"

Tickets

Use this method to get information about a specific case or all Ticket of them. You also use it to create new Tickets or update tags for the existing Tickets.

Available paths {#tickets-available-paths}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Methods	Path
`GET`	`/tickets/<TICKET_ID>`
`POST`	`/tickets`
`PUT`	`/tickets/<TICKET_ID>/tags`

Get list of tickets

\n
Path
\n

GET https://api.livechatinc.com/tickets\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/tickets?\\\ndate_from=2013-11-15&\\\nstatus=open\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \n

\n
Sample response
\n

{\n  \"pages\": 1,\n  \"total\": 15,\n  \"tickets\": [\n  {\n    \"assignee\": {\n      \"id\": \"jane.doe@mycompany.com\",\n      \"name\": \"Jane Doe\"\n    },\n    \"events\": [\n    {\n      \"author\": {\n        \"id\": \"mary.brown@email.com\",\n        \"name\": \"Mary Brown\",\n        \"type\": \"client\"\n      },\n      \"date\": 1384554260,\n      \"is_private\": false,\n      \"message\": \"Hello,\\n\\nIt seems that my new shoes are broken. What can we do about this?\",\n      \"type\": \"message\",\n      \"source\": {\n        \"type\": \"mail\"\n      }\n    }, {\n      \"to\": {\n        \"id\": \"jane.doe@mycompany.com\",\n        \"name\": \"Jane Doe\"\n      },\n      \"author\": {\n        \"id\": \"john.doe@mycompany.com\",\n        \"name\": \"John Doe\"\n      },\n      \"date\": 1384554270,\n      \"type\": \"assignee_changed\"\n    }, {\n      \"message\": \"Jane, could you please find a moment to handle this customer's complaint?\",\n      \"is_private\": true,\n      \"author\": {\n        \"type\": \"agent\",\n        \"id\": \"john.doe@mycompany.com\",\n        \"name\": \"John Doe\"\n      },\n      \"date\": 1384554322,\n      \"type\": \"message\",\n      \"source\": {\n        \"type\": \"lc2\"\n      }\n    }],\n    \"id\": \"5FUED\",\n    \"requester\": {\n      \"mail\": \"mary.brown@email.com\",\n      \"name\": \"Mary Brown\"\n    },\n    \"groups\": [0],\n    \"status\": \"open\",\n    \"subject\": \"My new shoes are broken\",\n    \"modified\": 1384790802,\n    \"source\": {\n      \"type\": \"mail\"\n    },\n    \"opened\": [{\n      \"from\": 1384554260\n    }],\n    \"firstResponse\": {}\n  },\n  \"tags\": [\n    \"sales\",\n    \"support\",\n    \"feedback\"\n  ],\n  (...)\n  ]\n}\n

Returns all tickets.

Optional parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`date_from`	`YYYY-MM-DD`. Returns the tickets with any of their activities matching the date. Defaults to `the beginning of time`
`date_to`	`YYYY-MM-DD`. Returns the tickets with any of their activities matching the date. Defaults to `today`
`page`	page number, defaults to 1
`assigned`	if `0`, returns only the unassigned tickets. If `1`, returns only the tickets assigned to any agent
`order`	orders the tickets by date of the last ticket modification. Possible values: `desc`, `asc`. Defaults to `desc`
`status`	not set by default. Possible values: `open`, `pending`, `solved` or `spam`
`assignee`	return the tickets assigned to the given agent's login
`query`	return the tickets containing the query
`requester[mail]`	returns the tickets assigned to the given requester
`group`	returns the tickets for the given group
`source`	returns the tickets for the given source. Possible values: `lc2` (created from archives), `mail`, `facebook`, `agent-app-manual` (created manually), `chat-window` (created from ticket form)
`tag`	returns the statistics for the specified tag
`tagged`	`1/0`. If 1 is passed, returns the tickets with any tag. If 0 passed, returns the tickets with no tags

Additional info:

The results are divided into pages, each containing 25 tickets.

total indicates the total number of tickets.
pages indicstes the total number of pages.

To access next pages of the results, use ?page=<PAGE> parameter.
Please note that the first page's number is 1, not 0.

Get single ticket

\n
Path
\n

GET https://api.livechatinc.com/tickets/<TICKET_ID>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/tickets/5FUED\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \n

\n
Sample response
\n

\n
The return format is the same as the single ticket item in tickets list.
\n

Returns a single ticket item for the given TICKET_ID.

Create a ticket

\n
Path
\n

POST https://api.livechatinc.com/tickets\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/tickets\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2  \\\n  -X POST -d \"subject=I+have+a+problem&\\\n  message=Hi,I+have+a+problem+with+my+shoes.+Could+you+please+advise?&\\\n  requester[mail]=mary.brown@email.com&\\\n  requester[name]=Mary+Brown\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/tickets\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n      \"subject\":\"I have a problem\",\n      \"message\":\"Hi,I have a problem with my shoes. Could you please advise?\",\n      \"requester\":\n      {\n        \"mail\":\"mary.brown@email.com\",\n        \"name\":\"Mary Brown\"\n      }\n     }'\n

\n
Sample response
\n

The return format is the same as the single ticket item in [tickets list](#get-tickets).\n\n

Creates a new ticket.

Required parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`message`	requester's message
`requester[mail]`	requester's email address

Optional parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`requester[name]`	requester's name
`assignee[id]`	login of the agent that will be assigned to the ticket
`source[type]`	source of the ticket. Possible values: `chat-window`, `mail` or `lc2`. Defaults to `lc2`
`source[url]`	url of the website that the ticket was sent from. Applies only if `source[type]` is `chat-window`
`subject`	ticket subject. Defaults to `(no subject)`
`group`	list of groups. Must be an array with group IDs. Defaults to `[0]`

Update ticket tags

\n
Path
\n

PUT https://api.livechatinc.com/tickets/<TICKET_ID>/tags\n

Sample

\n
Example request
\n

curl \"https://api.livechatinc.com/tickets/5FUED/tags\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X PUT \\\n  -d \"tag[]=sales&\\\ntag[]=support&\\\ntag[]=feedback\" \n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/tickets/5FUED/tags\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n        \"tag\":[\"sales\",\"support\",\"feedback\"]\n     }'\n

\n
Sample response
\n

{\n  \"pages\": 1,\n  \"total\": 15,\n  \"tickets\": [\n  {\n    \"assignee\": {\n      \"id\": \"jane.doe@mycompany.com\",\n      \"name\": \"Jane Doe\"\n    },\n    \"events\": [\n    {\n      \"author\": {\n        \"id\": \"mary.brown@email.com\",\n        \"name\": \"Mary Brown\",\n        \"type\": \"client\"\n      },\n      \"date\": 1384554260,\n      \"is_private\": false,\n      \"message\": \"Hello,\\n\\nIt seems that my new shoes are broken. What can we do about this?\",\n      \"type\": \"message\",\n      \"source\": {\n        \"type\": \"mail\"\n      }\n    }, {\n      \"to\": {\n        \"id\": \"jane.doe@mycompany.com\",\n        \"name\": \"Jane Doe\"\n      },\n      \"author\": {\n        \"id\": \"john.doe@mycompany.com\",\n        \"name\": \"John Doe\"\n      },\n      \"date\": 1384554270,\n      \"type\": \"assignee_changed\"\n    }, {\n      \"message\": \"Jane, could you please find a moment to handle this customer's complaint?\",\n      \"is_private\": true,\n      \"author\": {\n        \"type\": \"agent\",\n        \"id\": \"john.doe@mycompany.com\",\n        \"name\": \"John Doe\"\n      },\n      \"date\": 1384554322,\n      \"type\": \"message\",\n      \"source\": {\n        \"type\": \"lc2\"\n      }\n    }],\n    \"id\": \"5FUED\",\n    \"requester\": {\n      \"mail\": \"mary.brown@email.com\",\n      \"name\": \"Mary Brown\"\n    },\n    \"groups\": [0],\n    \"status\": \"open\",\n    \"subject\": \"My new shoes are broken\",\n    \"modified\": 1384790802,\n    \"source\": {\n      \"type\": \"mail\"\n    },\n    \"opened\": [{\n      \"from\": 1384554260\n    }],\n    \"firstResponse\": {}\n  },\n  \"tags\": [\n    \"sales\",\n    \"support\",\n    \"feedback\"\n  ],\n  (...)\n  ]\n}\n

Updates tags associated with the ticket.

Required parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`tag`	array of used tags

","event":[{"listen":"prerequest","script":{"id":"160afbc8-597f-4969-9b15-82fb357005f5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c3c0fffd-da62-4da3-96d1-3af464e1059c","type":"text/javascript","exec":[""]}}],"_postman_id":"466e09fd-c244-d3af-0945-0cb1504e7596","auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":true,"source":{"_postman_id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","name":"LiveChat REST API","type":"collection"}}},{"name":"Visitors","item":[{"name":"List all visitors","id":"99f1d5fa-ba12-3ceb-ba90-6bc0a884f0c7","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/visitors?state=chatting&group[]=0","description":"

Returns a list of the visitors on the pages with the tracking code installed.

\n","urlObject":{"protocol":"https","path":["visitors"],"host":["api","livechatinc","com"],"query":[{"key":"state","value":"chatting"},{"key":"group[]","value":"0"}],"variable":[]}},"response":[],"_postman_id":"99f1d5fa-ba12-3ceb-ba90-6bc0a884f0c7"},{"name":"Add custom visitor details","id":"930ead08-1290-7650-fd10-194999619c15","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"license_id","value":"12345","type":"text"},{"key":"token","value":"26132406c42c96ba61ed42689b70f719","type":"text"},{"key":"id","value":"my-app","type":"text"},{"key":"fields[0][name]","value":"Age","type":"text"},{"key":"fields[0][value]","value":"36","type":"text"}]},"url":"https://api.livechatinc.com/visitors/S1352647457.ac951bfe2e/details","description":"

Displays additional information about a visitor in LiveChat apps.

\n","urlObject":{"protocol":"https","path":["visitors","S1352647457.ac951bfe2e","details"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"930ead08-1290-7650-fd10-194999619c15"}],"id":"fb03d059-beba-2373-950d-64cf9e0115a7","description":"

Visitors

You can use this method to get information about the real-time Visitors on your website. You can also use it to display additional information about the visitors in the LiveChat app.

Available paths {#visitors-available-paths}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Methods	Path
`GET`	`/visitors`
`POST`	`/visitors/<VISITOR_ID>/details`

List all visitors

\n
Path
\n

GET https://api.livechatinc.com/visitors\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/visitors?\nstate=chatting&\\\ngroup[]=0\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 -g\n

\n
Sample response
\n

[\n  {\n    \"browser\": \"Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\",\n    \"chat\": {\n      // (...)\n    },\n    \"chat_id\": \"DL1G0UED4H\",\n    \"chat_start_time\": \"2017-02-16 12:54:26\",\n    \"chat_start_time_ts\": 1487246066,\n    \"chats\": 1,\n    \"custom_variables\": [\n      {\n        \"key\": \"empty_cart\",\n        \"value\": \"true\"\n      }\n    ],\n    \"city\": \"Greenville\",\n    \"country\": \"United States\",\n    \"country_code\": \"US\",\n    \"greetings_accepted\": 1,\n    \"greetings_all\": 2,\n    \"greetings_refused\": 1,\n    \"group\": 102,\n    \"host\": \"very-hosty.sl.us\",\n    \"id\": \"S148dea44981.d9443253fef2\",\n    \"invitation\": \"\",\n    \"ip\": \"8.8.8.8\",\n    \"language\": \"en\",\n    \"last_visit\": \"2017-02-16 12:36:21\",\n    \"last_visit_ts\": 1487244981,\n    \"latitude\": \"35.6127\",\n    \"longitude\": \"-77.3663\",\n    \"name\": \"Visitor\",\n    \"operators\": [\n      // (...)\n    ],\n    \"page_address\": \"https://docs.livechatinc.com/js-api/#on-chat-window-minimized\",\n    \"page_current\": \"https://docs.livechatinc.com/js-api/#on-chat-window-minimized\",\n    \"page_entered\": \"2017-02-16 12:36:21\",\n    \"page_entered_ts\": 1487244981,\n    \"page_time\": \"2017-02-16 12:39:12\",\n    \"page_time_ts\": 1487245152,\n    \"page_title\": \"LiveChat – Chat Window API (JS)\",\n    \"page_views\": 16,\n    \"prechat_survey\": [\n      // (...)\n    ],\n    \"queue_start_time\": 46843480,\n    \"referrer\": \"https://www.livechatinc.com/\",\n    \"region\": \"North Carolina\",\n    \"state\": \"chatting\",\n    \"timezone\": \"America/New_York\",\n    \"visit_path\": [\n      {\n        \"invitation\": \"Time on site: 30 sec\",\n        \"page\": \"https://developers.livechatinc.com/\",\n        \"time\": \"2017-02-16 12:36:21\",\n        \"time_ref\": 1487244981,\n        \"time_ts\": 1487244981,\n        \"title\": \"LiveChat Developers - REST API & Integrations\"\n      },\n      {\n        \"invitation\": \"\",\n        \"page\": \"https://docs.livechatinc.com/\",\n        \"time\": \"2017-02-16 12:38:33\",\n        \"time_ref\": 1487245113,\n        \"time_ts\": 1487245113,\n        \"title\": \"LiveChat Docs\"\n      },\n      // (...)\n    ],\n    \"visits\": 3\n  },\n  // (...)\n]\n

Returns a list of the visitors on the pages with the tracking code installed.

Optional parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`state`	parameter determines what state the visitors are. Possible values: `chatting`, `queued`, `browsing`, `invited`, `refused invitation` or `chat closed`
`group[]`	parameter decides which group will be used for the listing. Use group numbers as values to select visitors only for the specified group
`count`	parameter will allow you to return the number of visitors (when the value is set to `1`) instead of all the available information (when it is set to `0`). The parameter is set to `0` by default

Additional info:

The possible state values returned without any filter are:

browsing
chatting
logging into chat
queued
invited
refused invitation
chat closed

The possible state filter values are chatting and queued.

prechat_survey parameter will be available only if the visitor is currently chatting.

custom_variables parameter will be available only if the custom variables are defined in the tracking code.

Add custom visitor details

\n
Path
\n

POST https://api.livechatinc.com/visitors/<VISITOR_ID>/details\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/visitors/S1352647457.ac951bfe2e/details\" \\\n  -H X-API-Version:2\n  -d \"license_id=12345&\\\ntoken=26132406c42c96ba61ed42689b70f719&\\\nid=my-app&\\\nfields[0][name]=Age&\\\nfields[0][value]=36\"\n

\n
Sample JSON request
\n

curl \"https://api.livechatinc.com/visitors/S1352647457.ac951bfe2e/details\" \\\n  -H X-API-Version:2 \\\n  -H Content-type:application/json \\\n  -d '{\n        \"license_id\":12345,\n        \"token\":\"26132406c42c96ba61ed42689b70f719\",\n        \"id\":\"my-app\",\n        \"fields\":[\n          {\n            \"name\":\"Age\",\n            \"value\":36\n          }\n        ]\n      }'\n

\n
Sample response
\n

{\n  \"result\": \"Visitor details added\"\n}\n

Displays additional information about a visitor in LiveChat apps.

For example, if you have your own database with some additional details about your users, you can query this database based on your visitor’s e-mail address, and display the data from your database for an agent during the chat.

\n\n

Note: this method can only be used along with the Webhooks. You should create a webhook with chat_started event that will be sent to your integration script. This script must read webhook's license_id and token params and include them in this API method call. See a sample integration in Webhooks documentation.

Required properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`license_id`	sent by the webhook (read the note above)
`token`	sent by the webhook (read the note above)
`id`	descriptive ID your data set, for example: \"my-app\". It lets us group the data into one set and display many different data sets for single visitor. It should include only alphanumeric characters (letters, digits, punctuation marks)
`fields`	array of data objects that include `name` and `value` properties. This is the actual data that you have about your visitor. This data will be displayed to the agent during the chat. For the links you can also pass the anchor text. By adding `url` param, the value field would act as the anchor.

Optional properties

\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`icon`	address of the icon picture that will be displayed in the LiveChat app next to visitor’s data. It lets you group important information. `icon` should be a URL without the `http://` prefix. Your web server should support serving the icon file using https:// (SSL) protocol. The icon’s dimensions must be 64x64 px.

","event":[{"listen":"prerequest","script":{"id":"108fdbb6-00bd-4dc0-95b9-517e3afc8089","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"285865b3-7cdf-4645-965b-97ba2192e83a","type":"text/javascript","exec":[""]}}],"_postman_id":"fb03d059-beba-2373-950d-64cf9e0115a7","auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":true,"source":{"_postman_id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","name":"LiveChat REST API","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Display configured webhooks","id":"e971938e-53ef-b43e-898b-4fa71b4eeea5","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"GET","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/webhooks","description":"

Returns a list of webhooks that have been created in a LiveChat account.

\n","urlObject":{"protocol":"https","path":["webhooks"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e971938e-53ef-b43e-898b-4fa71b4eeea5"},{"name":"Create a new webhook","id":"8e43f5fd-63d5-fbb6-3ef7-8d79f22e5664","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"POST","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[{"key":"event_type","value":"chat_started","type":"text"},{"key":"data_types[]","value":"chat","type":"text"},{"key":"data_types[]","value":"visitor","type":"text"},{"key":"url","value":"http://my-company.com/parse_webhook.php","type":"text"}]},"url":"https://api.livechatinc.com/webhooks","description":"

Creates a new webhook.

\n","urlObject":{"protocol":"https","path":["webhooks"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8e43f5fd-63d5-fbb6-3ef7-8d79f22e5664"},{"name":"Delete a webhook","id":"acbac7cf-3bd0-5764-9217-07a53caa2ef6","request":{"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":false},"method":"DELETE","header":[{"key":"X-API-Version","value":"2"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.livechatinc.com/webhooks/12345","description":"

Deletes a webhook with the given ID.

\n","urlObject":{"protocol":"https","path":["webhooks","12345"],"host":["api","livechatinc","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"acbac7cf-3bd0-5764-9217-07a53caa2ef6"}],"id":"28b1730a-4891-2fa7-0f95-c748ec7db2ad","description":"

Webhooks

This method will help you build your own LiveChat integrations by creating and managing webhooks.

Check out our webhooks tutorial for more information, use cases and to learn how to get started.

Available paths {#webhooks-available-paths}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Methods	Path
`GET`	`/webhooks`
`POST`	`/webhooks`
`DELETE`	`/webhooks/<WEBHOOK_ID>`

Display configured webhooks

\n
Path
\n

GET https://api.livechatinc.com/webhooks\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/webhooks\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n

\n
Sample response
\n

{\n    \"events\": [{\n        \"licence\": 12345,\n        \"event_type\": \"chat_started\",\n        \"data_types\": [\"chat\", \"visitor\"],\n        \"url\": \"https://my-company.com/parse_webhook.php\",\n        \"verified\": true,\n        \"token\": \"0adec158e423091d5a36c9fce95775db\",\n        \"id\": \"39612eee5f1b431217aafb9de19c1e32\"\n    }]\n}\n

Returns a list of webhooks that have been created in a LiveChat account.

Create a new webhook

\n
Path
\n

POST https://api.livechatinc.com/webhooks\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/webhooks\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2\n  -d \"event_type=chat_started&\\\ndata_types[]=chat&\\\ndata_types[]=visitor&\\\nurl=http://my-company.com/parse_webhook.php\n

\n
Sample response
\n

{\n    \"events\": [{\n        \"licence\": 12345,\n        \"event_type\": \"chat_started\",\n        \"data_types\": [\"chat\", \"visitor\"],\n        \"url\": \"https://my-company.com/parse_webhook.php\",\n        \"verified\": true,\n        \"token\": \"0adec158e423091d5a36c9fce95775db\",\n        \"id\": \"39612eee5f1b431217aafb9de19c1e32\"\n    }]\n}\n

Creates a new webhook.

Required properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`event_type`	must be one of `chat_started`, `chat_ended`, `chat_changed`, `visitor_queued`, `ticket_created` or `canned_response_changed`
`data_types`	determines what information the webhook will contain
`url`	the URL address the webhook will be sent to

Additional info:

event_type determines when the webhook will be sent to your script:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`chat_started`	when the chat is started
`chat_ended`	when the chat is ended
`chat_changed`	when the chat is tagged
`visitor_queued`	when the visitor enters the queue before a chat
`ticket_created`	when a new ticket is created
`canned_response_changed`	when a canned response is created, modified or deleted

data_type is an array that includes one or more of the following values):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
`chat`	only supported in `chat_started`, `chat_changed` and `chat_ended` event types
`visitor`	only supported in `chat_started`, `chat_ended`, `chat_changed` and `visitor_queued` event types
`pre_chat_survey`	only supported in `chat_started` and `chat_ended` event types
`ticket`	only supported in `ticket_created` event type
`canned_response`	only supported in `canned_response_changed` event type

Delete a webhook

\n
Path
\n

DELETE https://api.livechatinc.com/webhooks/<ID>\n

\n
Sample request
\n

curl \"https://api.livechatinc.com/webhooks/39612eee5(...)\" \\\n  -u john.doe@mycompany.com:c14b85863755158d7aa5cc4ba17f61cb \\\n  -H X-API-Version:2 \\\n  -X DELETE\n

\n
Sample response
\n

{\n    \"result\":\"Push notification removed successfully\"\n}\n

Deletes a webhook with the given ID.

\n","event":[{"listen":"prerequest","script":{"id":"00756ff3-438d-4de7-9e43-05cb0973c67f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8bf5123f-47d3-4e9c-8b3b-a5bd60e6ce13","type":"text/javascript","exec":[""]}}],"_postman_id":"28b1730a-4891-2fa7-0f95-c748ec7db2ad","auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""},"isInherited":true,"source":{"_postman_id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","id":"4a592118-5cdd-b8b6-2f1e-09e0555283fd","name":"LiveChat REST API","type":"collection"}}}],"auth":{"type":"oauth2","oauth2":{"accessToken":"","tokenType":""}},"event":[{"listen":"prerequest","script":{"id":"d86412fc-5641-4838-be51-4ff2cebf95e6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"87368235-754f-48f2-a072-f8fa668a91a4","type":"text/javascript","exec":[""]}}]}

Parameter	Description
`author`	agent login
`tag`	name of a tag
`group`	id of the group that tag will be added to

Property	Description
`tag`	tag name
`group`	id of the group that the tag is assigned to