> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# LiveChat V3 Connector

## Intro

LiveChat is an online customer service software with online chat, help desk software, and web analytics capabilities. Use Domo’s LiveChat connector to delight your customers and fuel your sales. To learn more about the LiveChat V3 API, visit [https://developers.livechat.com/updates/release-stable-livechat-api-v3-2](https://developers.livechat.com/updates/release-stable-livechat-api-v3-2 "https://developers.livechat.com/updates/release-stable-livechat-api-v3-2").

You connect to your LiveChat account in the Data Center. This topic discusses the fields and menus that are specific to the LiveChat connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [Adding a DataSet Using a Data Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Data Connector").

## Prerequisites

To connect to your LiveChat account and create a DataSet, you must have the following:

* Your LiveChat Account ID
* Your LiveChat Personal Access Token

## Connecting to Your LiveChat Account

This section enumerates the options in the **Credentials** and **Details** panes on the LiveChat Connector page. The components of the other panes on this page, **Scheduling**, and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Data Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Data Connector").

## Credentials Pane

This pane contains fields for entering credentials to connect to your LiveChat account. The following table describes what is needed for each field:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p><span class="s1"> Field </span></p></th><th colspan="1" rowspan="1"><p><span class="s1"> Description </span></p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"> Account ID </td><td colspan="1" rowspan="1"> Enter your LiveChat account ID. </td></tr><tr><td colspan="1" rowspan="1"> Personal Access Token </td><td colspan="1" rowspan="1"> Enter your LiveChat personal access token. </td></tr></tbody></table>

Once you have entered valid LiveChat credentials, you can use the same account any time you go to create a new LiveChat DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](https://domo-support.domo.com/s/article/360042926054?language=en_US "Managing User Accounts for Connectors").

## Details Pane

This pane contains a primary **Reports** menu, along with various other menus which may or may not appear depending on the report type you select.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the LiveChat report you want to run. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><b> Report Name </b></td><td colspan="1" rowspan="1"><b> Description </b></td></tr><tr><td colspan="1" rowspan="1"> Availability </td><td colspan="1" rowspan="1"> Shows for how long an agent, group, or the whole account was available for chatting during a specified period of time. </td></tr><tr><td colspan="1" rowspan="1"><p> Performance </p></td><td colspan="1" rowspan="1"> Shows the total number of agent's chats, the number of good and bad rates they received, and how well they performed in the early stages of a chat. Additionally, the report shows the time an agent spent chatting, accepting, and not accepting chats, as well as the total time they were logged in. </td></tr><tr><td colspan="1" rowspan="1"><p> Chat Usage </p></td><td colspan="1" rowspan="1"> Shows the total number of chats marked with each tag listed in the report. </td></tr><tr><td colspan="1" rowspan="1"><p> Duration </p></td><td colspan="1" rowspan="1"> Shows the average chatting duration of agents within a license. </td></tr><tr><td colspan="1" rowspan="1"><p> Tags </p></td><td colspan="1" rowspan="1"> Shows the distribution of tags for chats. </td></tr><tr><td colspan="1" rowspan="1"><p> Total Chats </p></td><td colspan="1" rowspan="1"> Shows how many chats occurred during the specified period. </td></tr><tr><td colspan="1" rowspan="1"><p> Ratings </p></td><td colspan="1" rowspan="1"> Shows the number of rated chats along with their ratings during a specified period of time. </td></tr><tr><td colspan="1" rowspan="1"><p> Ranking </p></td><td colspan="1" rowspan="1"> Shows the ratio of good to bad ratings for each operator. </td></tr><tr><td colspan="1" rowspan="1"><p> Engagement </p></td><td colspan="1" rowspan="1"> Shows the distribution of chats based on engagement during the specified period. </td></tr><tr><td colspan="1" rowspan="1"><p> Greetings Conversion </p></td><td colspan="1" rowspan="1"> Shows the number of greetings sent to the customers and how many of those resulted in a chat or a goal. Greetings are also known as targeted messages. The method will return only up to 100 values for each day. If there are more than 100 values, use the LiveChat App to access the full data for a given day. </td></tr><tr><td colspan="1" rowspan="1"><p> Forms </p></td><td colspan="1" rowspan="1"> Returns the number of submitted chat forms along with the count of specific answers. </td></tr><tr><td colspan="1" rowspan="1"><p> Response Time </p></td><td colspan="1" rowspan="1"> Shows the average agent's response time within a license. </td></tr><tr><td colspan="1" rowspan="1"><p> First Response Time </p></td><td colspan="1" rowspan="1"> Shows the average agent's first response time within a license. </td></tr><tr><td colspan="1" rowspan="1"><p> Availability (Deprecated) </p></td><td colspan="1" rowspan="1"> Returns statistics on availability. </td></tr><tr><td colspan="1" rowspan="1"> Chats - Chatting Time (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on time spent chatting </td></tr><tr><td colspan="1" rowspan="1"> Chats - Engagement (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on chat engagement </td></tr><tr><td colspan="1" rowspan="1"> Chats - First Response Time (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on time to first response in chats </td></tr><tr><td colspan="1" rowspan="1"> Chats - Goals (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on goals </td></tr><tr><td colspan="1" rowspan="1"> Chats - Greetings (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on greetings </td></tr><tr><td colspan="1" rowspan="1"> Chats - Not Replied Chats (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on chats not replied </td></tr><tr><td colspan="1" rowspan="1"> Chats - Queued Visitors (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on number of queued visitors </td></tr><tr><td colspan="1" rowspan="1"> Chats - Queued Visitors Waiting Times (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on how long queued visitors are waiting </td></tr><tr><td colspan="1" rowspan="1"> Chats - Rankings (Deprecated) </td><td colspan="1" rowspan="1"> Returns chat ranking data </td></tr><tr><td colspan="1" rowspan="1"> Chats - Ratings (Deprecated) </td><td colspan="1" rowspan="1"> Returns chat ratings data </td></tr><tr><td colspan="1" rowspan="1"> Chats - Response Time (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on chat response times </td></tr><tr><td colspan="1" rowspan="1"> Chats - Total Chats (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on total number of chats </td></tr><tr><td colspan="1" rowspan="1"> Tickets - First Response Time (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on time to first response on tickets </td></tr><tr><td colspan="1" rowspan="1"> Tickets - New Tickets (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on new tickets </td></tr><tr><td colspan="1" rowspan="1"> Tickets - Rankings (Deprecated) </td><td colspan="1" rowspan="1"> Returns data on ticket rankings </td></tr><tr><td colspan="1" rowspan="1"> Tickets - Ratings (Deprecated) </td><td colspan="1" rowspan="1"> Returns data on ticket ratings </td></tr><tr><td colspan="1" rowspan="1"> Tickets - Resolution Time (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on ticket resolution time </td></tr><tr><td colspan="1" rowspan="1"> Tickets - Solved Tickets (Deprecated) </td><td colspan="1" rowspan="1"> Returns statistics on solved tickets </td></tr><tr><td colspan="1" rowspan="1"> Tickets - Ticket Sources (Deprecated) </td><td colspan="1" rowspan="1"> Returns data on Ticket Sources </td></tr><tr><td colspan="1" rowspan="1"> Agents </td><td colspan="1" rowspan="1"> Returns a list of agents </td></tr><tr><td colspan="1" rowspan="1"> Bot Agents </td><td colspan="1" rowspan="1"> Returns a list of bot agents </td></tr><tr><td colspan="1" rowspan="1"> Groups </td><td colspan="1" rowspan="1"> Returns a list of groups </td></tr><tr><td colspan="1" rowspan="1"> License Properties </td><td colspan="1" rowspan="1"> Returns a list of license properties </td></tr><tr><td colspan="1" rowspan="1"> Registered Properties </td><td colspan="1" rowspan="1"> Returns a list of registered properties </td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"> Date Selection </td><td colspan="1" rowspan="1"> Select the date format for your data. </td></tr><tr><td colspan="1" rowspan="1"> Single Date </td><td colspan="1" rowspan="1"> Select whether the report data is for a specific date or a relative number of days back from today. </td></tr><tr><td colspan="1" rowspan="1"> Single Date - Specific </td><td colspan="1" rowspan="1"> Select the specific date using the date selector. </td></tr><tr><td colspan="1" rowspan="1"> Single Date - Relative </td><td colspan="1" rowspan="1"> Enter the number of days back that you would like to get data for in the <b><b> Days Back </b></b> field. Specify either today or 0, yesterday or 1, or today or 7 to get data for 7 days into the past. </td></tr><tr><td colspan="1" rowspan="1"> Date Range </td><td colspan="1" rowspan="1"> Select the specific or relative date range. </td></tr><tr><td colspan="1" rowspan="1"> Start Date - Specific </td><td colspan="1" rowspan="1"> Select the first date in your date range using the date selector. </td></tr><tr><td colspan="1" rowspan="1"> End Date - Specific </td><td colspan="1" rowspan="1"> Select the last date in your date range using the date selector. </td></tr><tr><td colspan="1" rowspan="1"> Start Date - Relative </td><td colspan="1" rowspan="1"><p> Enter the number of days back that you would like to get data from (start day). Combine with <b><b><b><b><b><b><b><b> End Date </b></b></b></b></b></b></b></b> to create a range of represented days. </p><p> For example, if you entered 10 for <b><b><b><b><b><b><b><b> Start Date </b></b></b></b></b></b></b></b> and 5 for <b><b><b><b><b><b><b><b> End Date </b></b></b></b></b></b></b></b>, the report would contain data from 10 days ago up until 5 days ago. </p></td></tr><tr><td colspan="1" rowspan="1"> End Date - Relative </td><td colspan="1" rowspan="1"><p> Enter the number of days back that you would like to get data to (end day). Combine with <b><b><b><b><b><b><b><b> Start Date </b></b></b></b></b></b></b></b> to create a range of represented days. </p><p> For example, if you entered 10 for <b><b><b><b><b><b><b><b> Start Date </b></b></b></b></b></b></b></b> and 5 for <b><b><b><b><b><b><b><b> End Date </b></b></b></b></b></b></b></b>, the report would contain data from 10 days ago up until 5 days ago. </p></td></tr><tr><td colspan="1" rowspan="1"> Time Period </td><td colspan="1" rowspan="1"> Specify the time period that you would like to receive data for. </td></tr><tr><td colspan="1" rowspan="1"> Starting Day of the Week </td><td colspan="1" rowspan="1"> Select the day you would like your week to start with. </td></tr></tbody></table>

## Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see [Adding a DataSet Using a Data Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Data Connector").

## FAQs

<AccordionGroup>
  <Accordion title="What endpoint is the base URL for this connector?">
    The base URL for LiveChat is [https://api.livechatinc.com](https://api.livechatinc.com).
  </Accordion>

  <Accordion title="Which endpoint does each report call in this connector?">
    <table border="1" data-aura-rendered-by="33:195;a"><tbody><tr><td colspan="1" rowspan="1"><b> Report Type </b></td><td colspan="1" rowspan="1"><b> Report Name </b></td><td colspan="1" rowspan="1"><b> Endpoint URL </b></td></tr><tr><td colspan="1" rowspan="1"><b> Reports API </b></td><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1" /></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Availability </td><td colspan="1" rowspan="1"> /reports/availability </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Chats - Chatting Time </td><td colspan="1" rowspan="1"> /reports/chats/chatting\_time </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Chats - Engagement </td><td colspan="1" rowspan="1"> /reports/chats/engagement </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Chats - First Response Time </td><td colspan="1" rowspan="1"> /reports/chats/first\_response\_time </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Chats - Goals </td><td colspan="1" rowspan="1"> /reports/chats/goals </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Chats - Greetings </td><td colspan="1" rowspan="1"> /reports/chats/greetings </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Chats - Not Replied Chats </td><td colspan="1" rowspan="1"> /reports/chats/not\_replied\_chats </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Chats - Queued Visitors </td><td colspan="1" rowspan="1"> /reports/chats/queued\_visitors </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Chats - Queued Visitors Waiting Times </td><td colspan="1" rowspan="1"> /reports/chats/queued\_visitors/waiting\_times </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Chats - Rankings </td><td colspan="1" rowspan="1"> /reports/chats/ratings/ranking </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Chats - Ratings </td><td colspan="1" rowspan="1"> /reports/chats/ratings </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Chats - Response Time </td><td colspan="1" rowspan="1"> /reports/chats/response\_time </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Chats - Total Chats </td><td colspan="1" rowspan="1"> /reports/chats/total\_chats </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Tickets - First Response Time </td><td colspan="1" rowspan="1"> /reports/tickets/first\_response\_time </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Tickets - New Tickets </td><td colspan="1" rowspan="1"> /reports/tickets/new\_tickets </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Tickets - Rankings </td><td colspan="1" rowspan="1"> /reports/tickets/ratings/ranking </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Tickets - Ratings </td><td colspan="1" rowspan="1"> /reports/tickets/ratings </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Tickets - Resolution Time </td><td colspan="1" rowspan="1"> /reports/tickets/resolution\_time </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Tickets - Solved Tickets </td><td colspan="1" rowspan="1"> /reports/tickets/solved\_tickets </td></tr><tr><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1"> Tickets - Ticket Sources </td><td colspan="1" rowspan="1"> /reports/tickets/ticket\_sources </td></tr><tr><td colspan="1" rowspan="1"><b> Management API </b></td><td colspan="1" rowspan="1" /><td colspan="1" rowspan="1" /></tr><tr><td colspan="1" rowspan="1"><b /></td><td colspan="1" rowspan="1"> Agents </td><td colspan="1" rowspan="1"> /v3.2/configuration/action/list\_agents </td></tr><tr><td colspan="1" rowspan="1"><b /></td><td colspan="1" rowspan="1"> Bot Agents </td><td colspan="1" rowspan="1"> /v3.2/configuration/action/list\_bots </td></tr><tr><td colspan="1" rowspan="1"><b /></td><td colspan="1" rowspan="1"> Groups </td><td colspan="1" rowspan="1"> /v3.2/configuration/action/list\_groups </td></tr><tr><td colspan="1" rowspan="1"><b /></td><td colspan="1" rowspan="1"> License Properties </td><td colspan="1" rowspan="1"> /v3.2/configuration/action/list\_license\_properties </td></tr><tr><td colspan="1" rowspan="1"><b /></td><td colspan="1" rowspan="1"> Registered Properties </td><td colspan="1" rowspan="1"> /v3.2/configuration/action/list\_registered\_properties </td></tr></tbody></table>
  </Accordion>

  <Accordion title="What kind of credentials do I need to power up this connector?">
    You need the account id and personal access token associated with your LiveChat account.
  </Accordion>

  <Accordion title="How often can the data be updated?">
    As often as needed.
  </Accordion>

  <Accordion title="Are there any API limits that I need to be aware of?">
    No.
  </Accordion>

  <Accordion title="What's the difference between the LiveChat and LiveChat API V3 connectors?">
    The LiveChat API V3 connector uses the API version 3.2 for the Management API reports.
  </Accordion>
</AccordionGroup>
