# LiveChat

### Snapshot

| Features                        | Details                                            |
| ------------------------------- | -------------------------------------------------- |
| Release Status                  | Released                                           |
| Source API Version              | v2                                                 |
| Table Selection                 | Yes                                                |
| Column Selection                | Yes                                                |
| Edit Integration                | Yes                                                |
| Replication Type Selection      | No                                                 |
| Authentication Parameters       | <p>Livechat account email<br>Livechat password</p> |
| Replication Type                | <p>Key based Replication<br>Full Replication</p>   |
| Replication Key                 | Date                                               |
| Suggested Replication Frequency | 24 hrs                                             |

| Tables/APIs Supported |                              |
| --------------------- | ---------------------------- |
| list\_all\_agents     | list\_all\_canned\_responses |
| list\_all\_greetings  | list\_all\_groups            |
| list\_all\_tags       | total\_chats                 |
| chat\_engagements     |                              |

### Integrate Livechat with Daton

1. Signin to Daton&#x20;
2. Select Livechat from Integrations page
3. Provide Integration Name Replication Frequency and History. Integration name would be used in creating tables for the integration and cannot be changed later&#x20;
4. Provide your Livechat account email and Password to authorize Daton to periodically extract data from livechat.
5. Post successful authentication you will be prompted to choose from the list of available tables
6. Then select all required fields for each table
7. Submit the integration

### Workflow

1. Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
2. Users would be able to edit/pause/re-activate/delete integration anytime
3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

### LIVECHAT Data

**TotalChats**

Purpose: Shows how many chats occurred during a specified period.

Source API Documentation  <https://developers.livechatinc.com/docs/data-reporting/reports-api/#total-chats>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name          | TargetDatatype |
| ------------- | -------------- |
| date          | STRING         |
| chats         | NUMERIC        |
| missed\_chats | NUMERIC        |

**ChatEngagements**

Purpose: 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.

Source API Documentation  <https://developers.livechatinc.com/docs/data-reporting/reports-api/#chat-engagement>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name                          | Target Datatype |
| ----------------------------- | --------------- |
| date                          | STRING          |
| chats\_from\_auto\_invite     | NUMERIC         |
| chats\_from\_manual\_invite   | NUMERIC         |
| chats\_from\_immediate\_start | NUMERIC         |

**ListAllAgents**

Purpose:Returns all LiveChat agents list

Source API Documentation  <https://developers.livechatinc.com/docs/management/configuration-api/v2.0/#list-all-agents>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name       | Target Datatype |
| ---------- | --------------- |
| name       | STRING          |
| permission | STRING          |
| avatar     | STRING          |
| login      | STRING          |
| is\_bot    | BOOLEAN         |
| group\_ids | STRING          |
| status     | STRING          |

**ListAllCannedResponses**

Purpose:Returns the list of all currently set canned responses.

Source API Documentation  <https://developers.livechatinc.com/docs/management/configuration-api/v2.0/#list-all-canned-responses>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name               | Target Datatype |
| ------------------ | --------------- |
| id                 | NUMERIC         |
| group              | NUMERIC         |
| text               | STRING          |
| modification\_date | NUMERIC         |
| tags               | STRING          |

**ListAllTags**

Purpose:Returns tags from all groups.

Source API Documentation  h<https://developers.livechatinc.com/docs/management/configuration-api/v2.0/#list-all-tags>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name           | Target Datatype |
| -------------- | --------------- |
| name           | STRING          |
| author         | STRING          |
| creation\_date | NUMERIC         |
| count          | RECORD          |
| group          | NUMERIC         |

**ListAllGreetings**

Purpose:Returns the list of all greetings.

Source API Documentation  <https://developers.livechatinc.com/docs/management/configuration-api/v2.0/#list-all-greetings>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name       | Target Datatype |
| ---------- | --------------- |
| id         | NUMERIC         |
| active     | BOOLEAN         |
| name       | STRING          |
| group      | NUMERIC         |
| rules      | RECORD          |
| properties | RECORD          |

**ListAllGroups**

Purpose:Returns all created groups

Source API Documentation  <https://developers.livechatinc.com/docs/management/configuration-api/v2.0/#list-all-groups>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name     | Target Datatype |
| -------- | --------------- |
| id       | NUMERIC         |
| name     | STRING          |
| language | STRING          |
| status   | STRING          |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://daton-sarasanalytics.gitbook.io/daton/integrations/data-sources/saas-integrations/livechat.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.