Public LiveChat API Reference

The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the internal_ prefix in their names. Public API procedures do not have such prefixes in their names.

Agents

Agents
Parameter
<label> (optional): Multi-tenancy label

Attribute	Type
login	string
name	string
login_status	string
permission	string
daily_summary	integer
job_title	string
avatar	string
notifications_new_visitor	integer
notifications_returning_visitor	integer
notifications_queued_visitor	integer
notifications_visitor_is_typing	integer
notifications_new_goal	integer
max_chats_count	integer
groups	string
status	string
last_logout	timestamp
api_key	string

Report_Availability

Availability
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
timestamp	timestamp
hours	bigdecimal
minutes	integer

Example

SQL

CREATE VIEW livechat_examples.example_Report_Availability AS 
 	SELECT * FROM livechat.Report_Availability (
 		preview => TRUE
 	)

Report_ChatRanking

Chat Ranking
Parameter
<date_from> (required): Initial date
<date_to> (optional): End date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
date	date
bad	integer
good	integer
total	integer
score	bigdecimal
name	string

Example

SQL

CREATE VIEW livechat_examples.example_Report_ChatRanking AS 
 	SELECT * FROM livechat.Report_ChatRanking (
 		date_from => TimestampAdd (SQL_TSI_DAY, -1, CurDate()),
 		preview => TRUE
 	)

Report_ChatResponseTime

Chat Response Time
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
timestamp	timestamp
count	integer
seconds	integer

Example

SQL

CREATE VIEW livechat_examples.example_Report_ChatResponseTime AS 
 	SELECT * FROM livechat.Report_ChatResponseTime (
 		preview => TRUE
 	)

Report_ChattingTime

Chatting Time
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
timestamp	timestamp
hours	bigdecimal
minutes	integer

Example

SQL

CREATE VIEW livechat_examples.example_Report_ChattingTime AS 
 	SELECT * FROM livechat.Report_ChattingTime (
 		preview => TRUE
 	)

Report_Engagement

Engagement
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
timestamp	timestamp
chats_from_auto_invite	integer
chats_from_manual_invite	integer
chats_from_immediate_start	integer

Example

SQL

CREATE VIEW livechat_examples.example_Report_Engagement AS 
 	SELECT * FROM livechat.Report_Engagement (
 		preview => TRUE
 	)

Report_Greetings

Greetings
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
timestamp	timestamp
displayed	integer
accepted	integer
goals	integer
canceled	integer

Example

SQL

CREATE VIEW livechat_examples.example_Report_Greetings AS 
 	SELECT * FROM livechat.Report_Greetings (
 		preview => TRUE
 	)

Report_MissedChats

Missed Chats
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<agentBreakdown> (optional): Breakdown data by agent
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
agent	string
name	string
timestamp	timestamp
not_replied	integer

Example

SQL

CREATE VIEW livechat_examples.example_Report_MissedChats AS 
 	SELECT * FROM livechat.Report_MissedChats (
 		preview => TRUE
 	)

Report_NewTickets

New Tickets
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
timestamp	timestamp
new_tickets	integer

Example

SQL

CREATE VIEW livechat_examples.example_Report_NewTickets AS 
 	SELECT * FROM livechat.Report_NewTickets (
 		preview => TRUE
 	)

Report_QueueWaitingTimes

Queue Waiting Times
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
timestamp	timestamp
queued	integer
queued_min	integer
queued_max	integer
queued_average	bigdecimal
left_queue	integer
left_queue_min	integer
left_queue_max	integer
left_queue_average	bigdecimal
entered_chat	integer
entered_chat_min	integer
entered_chat_max	integer
entered_chat_average	bigdecimal

Example

SQL

CREATE VIEW livechat_examples.example_Report_QueueWaitingTimes AS 
 	SELECT * FROM livechat.Report_QueueWaitingTimes (
 		preview => TRUE
 	)

Report_Ratings

Ratings
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<agentBreakdown> (optional): Breakdown data by agent
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
agent	string
name	string
timestamp	timestamp
bad	integer
good	integer
chats	integer

Example

SQL

CREATE VIEW livechat_examples.example_Report_Ratings AS 
 	SELECT * FROM livechat.Report_Ratings (
 		preview => TRUE
 	)

Report_ResolutionTime

Ticket Resolution Time
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<agentBreakdown> (optional): Breakdown data by agent
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
agent	string
name	string
timestamp	timestamp
count	integer
hours	bigdecimal

Example

SQL

CREATE VIEW livechat_examples.example_Report_ResolutionTime AS 
 	SELECT * FROM livechat.Report_ResolutionTime (
 		preview => TRUE
 	)

Report_SolvedTickets

Solved Tickets
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
timestamp	timestamp
solved_tickets	integer

Example

SQL

CREATE VIEW livechat_examples.example_Report_SolvedTickets AS 
 	SELECT * FROM livechat.Report_SolvedTickets (
 		preview => TRUE
 	)

Report_TicketRatings

Ticket Ratings
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
timestamp	timestamp
bad	integer
good	integer

Example

SQL

CREATE VIEW livechat_examples.example_Report_TicketRatings AS 
 	SELECT * FROM livechat.Report_TicketRatings (
 		preview => TRUE
 	)

Report_TicketSources

Ticket Sources
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
timestamp	timestamp
tickets_from_chat_window	integer
tickets_from_mail	integer
tickets_from_chat	integer

Example

SQL

CREATE VIEW livechat_examples.example_Report_TicketSources AS 
 	SELECT * FROM livechat.Report_TicketSources (
 		preview => TRUE
 	)

Report_TicketsFirstResponseTime

Tickets First Response Time
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
timestamp	timestamp
count	integer
hours	bigdecimal

Example

SQL

CREATE VIEW livechat_examples.example_Report_TicketsFirstResponseTime AS 
 	SELECT * FROM livechat.Report_TicketsFirstResponseTime (
 		preview => TRUE
 	)

Report_TotalChats

Total Chats
Parameter
<date_from> (optional): Initial date
<date_to> (optional): End date
<agentBreakdown> (optional): Breakdown data by agent
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
agent	string
name	string
timestamp	timestamp
chats	integer
missed_chats	integer

Example

SQL

CREATE VIEW livechat_examples.example_Report_TotalChats AS 
 	SELECT * FROM livechat.Report_TotalChats (
 		preview => TRUE
 	)

Threads

Chat Threads
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type
chat_id	string
id	string
created_at	timestamp
recipients	string
type	string
text	string
author_id	string
custom_id	string
template_id	string
title	string