Schema Information of HelpScout v2
This subtopic provides a structured reference to assist you in working with Daton's HelpScout connector and the associated fields and tables.
Schema Information of HelpScout v2
This subtopic provides a structured reference to assist you in working with Daton's HelpScout connector and the associated fields and tables.
Tables/APIs
The following is the list of tables or APIs associated with the HelpScout connector:
- ChatReport
- ConversationDrilldownReport
- Conversations
- Customers
- DocsOverallReport
- EmailReport
- HappinessRatingsReport
- Mailbox
- PhoneReport
- ProductivityOverallReport
- Tags
- Teams
- UserHappinessReport
- UserOverallReport
- Users
- Workflows
ChatReport
Retrieves detailed reports and analytics related to chat interactions, helping to analyze chat performance and trends. For more information, see ChatReport.
This table in Daton doesn't support any primary key.
Fields
Field Name |
Data Type |
|---|---|
current |
RECORD |
waitTime |
RECORD |
responseTime |
RECORD |
messagesPerChat |
RECORD |
duration |
RECORD |
CompanyOverallReport
Provides an overview of the overall performance and metrics across the entire company or organization. For more information, see CompanyOverallReport.
Fields
Field Name |
Data Type |
|---|---|
startDate |
TIMESTAMP |
endDate |
TIMESTAMP |
customersHelped |
NUMERIC |
closed |
NUMERIC |
totalReplies |
NUMERIC |
totalUsers |
NUMERIC |
totalDays |
NUMERIC |
repliesPerDayPerUser |
BIGNUMERIC |
repliesPerDay |
BIGNUMERIC |
resolvedPerDay |
BIGNUMERIC |
newConversationsPerDay |
BIGNUMERIC |
name |
STRING |
user |
NUMERIC |
handleTime |
BIGNUMERIC |
replies |
NUMERIC |
happinessScore |
NUMERIC |
ConversationDrilldownReport
Offers in-depth insights into specific conversations, allowing a closer examination of communication details. For more information, see ConversationDrilldownReport.
Fields
Field Name |
Data Type |
|---|---|
id |
NUMERIC |
number |
NUMERIC |
assignedName |
STRING |
assignedType |
STRING |
attachments |
BOOLEAN |
subject |
STRING |
status |
STRING |
threadCount |
NUMERIC |
preview |
STRING |
customerName |
STRING |
customerEmail |
STRING |
customerIds |
STRING |
tags |
RECORD |
modifiedAt |
TIMESTAMP |
type |
STRING |
waitingSince |
TIMESTAMP |
waitingSinceType |
NUMERIC |
closedAt |
TIMESTAMP |
mailboxid |
NUMERIC |
assignedid |
NUMERIC |
ConversationThreads
Fields
Field Name |
Data Type |
|---|---|
id |
NUMERIC |
type |
STRING |
status |
STRING |
action |
RECORD |
source |
RECORD |
createdBy |
RECORD |
createdAt |
TIMESTAMP |
_links |
RECORD |
Conversations
Fields
Field Name |
Data Type |
|---|---|
id |
NUMERIC |
number |
NUMERIC |
threads |
NUMERIC |
type |
STRING |
folderId |
NUMERIC |
status |
STRING |
state |
STRING |
subject |
STRING |
preview |
STRING |
mailboxId |
NUMERIC |
createdBy |
RECORD |
createdAt |
TIMESTAMP |
closedBy |
NUMERIC |
closedByUser |
RECORD |
closedAt |
TIMESTAMP |
userUpdatedAt |
TIMESTAMP |
customerWaitingSince |
RECORD |
source |
RECORD |
tags |
RECORD |
primaryCustomer |
RECORD |
_embedded |
RECORD |
_links |
RECORD |
customFields |
RECORD |
assignee |
RECORD |
Customers
Provides information about customers using the platform, aiding in customer relationship management. For more information, see Customers.
Fields
Field Name |
Data Type |
|---|---|
id |
NUMERIC |
firstName |
STRING |
lastName |
STRING |
gender |
STRING |
photoType |
STRING |
photoUrl |
STRING |
createdAt |
TIMESTAMP |
updatedAt |
TIMESTAMP |
background |
STRING |
draft |
BOOLEAN |
_embedded |
RECORD |
_links |
RECORD |
DocsOverallReport
Offers an overview of documentation performance and analytics, helping to improve user support. For more information, see DocsOverallReport.
This table in Daton doesn't support any primary key.
Fields
Field Name |
Data Type |
|---|---|
current |
RECORD |
topArticles |
RECORD |
topCategories |
RECORD |
popularSearches |
RECORD |
failedSearches |
RECORD |
EmailReport
Retrieves data and insights from email communications, assisting in email performance assessment. For more information, see EmailReport.
This table in Daton doesn't support any primary key.
Fields
Field Name |
Data Type |
|---|---|
current |
RECORD |
responseTime |
RECORD |
handleTime |
RECORD |
firstResponseTime |
RECORD |
resolutionTime |
RECORD |
repliesToResolve |
RECORD |
HappinessRatingsReport
Provides reports on customer happiness ratings and feedback, aiding in user satisfaction analysis. For more information, see HappinessRatingsReport.
Fields
Field Name |
Data Type |
|---|---|
number |
NUMERIC |
threadid |
NUMERIC |
threadCreatedAt |
TIMESTAMP |
id |
NUMERIC |
type |
STRING |
ratingId |
NUMERIC |
ratingCustomerId |
NUMERIC |
ratingComments |
STRING |
ratingCreatedAt |
TIMESTAMP |
ratingCustomerName |
STRING |
ratingUserId |
NUMERIC |
ratingUserName |
STRING |
Mailbox
Enables access to mailbox data, assisting in managing and organizing communication channels. For more information, see Mailbox.
Fields
Field Name |
Data Type |
|---|---|
id |
NUMERIC |
name |
STRING |
slug |
STRING |
email |
STRING |
createdAt |
TIMESTAMP |
updatedAt |
TIMESTAMP |
_links |
RECORD |
PhoneReport
Retrieves reports and data from phone interactions, facilitating analysis of call performance. For more information, see PhoneReport.
Fields
Field Name |
Data Type |
|---|---|
startDate |
TIMESTAMP |
endDate |
TIMESTAMP |
phoneConversations |
NUMERIC |
phoneCallsCreated |
NUMERIC |
customers |
NUMERIC |
name |
STRING |
id |
NUMERIC |
current |
RECORD |
ProductivityOverallReport
Offers an overview of productivity metrics and trends across the Help Scout account. For more infomation, see ProductivityOverallReport.
This table in Daton doesn't support any primary key.
Fields
Field Name |
Data Type |
|---|---|
current |
RECORD |
responseTime |
RECORD |
handleTime |
RECORD |
firstResponseTime |
RECORD |
resolutionTime |
RECORD |
repliesToResolve |
RECORD |
Tags
Provides information about tags and their usage, aiding in categorization and organization. For more information, see Tags.
Fields
Field Name |
Data Type |
|---|---|
id |
NUMERIC |
slug |
STRING |
name |
STRING |
color |
STRING |
createdAt |
TIMESTAMP |
ticketCount |
NUMERIC |
Teams
Offers data about teams within the organization, assisting in team management. For more information, see Teams.
Fields
Field Name |
Data Type |
|---|---|
id |
NUMERIC |
name |
STRING |
timezone |
STRING |
photoUrl |
STRING |
createdAt |
TIMESTAMP |
updatedAt |
TIMESTAMP |
mention |
STRING |
initials |
STRING |
_links |
RECORD |
UserHappinessReport
Provides reports on user happiness ratings and feedback, aiding in user satisfaction assessment. For more information, see UserHappinessReport.
Fields
name |
type |
|---|---|
notGoodCount |
NUMERIC |
okay |
NUMERIC |
totalCustomers |
NUMERIC |
happinessScore |
NUMERIC |
totalConversationsWithRatings |
NUMERIC |
totalCustomersWithRatings |
NUMERIC |
ratingsCount |
NUMERIC |
ratingsPercent |
BIGNUMERIC |
notGood |
NUMERIC |
great |
NUMERIC |
greatCount |
NUMERIC |
okayCount |
NUMERIC |
userId |
NUMERIC |
UserOverallReport
Offers an overview of user performance and metrics, helping to analyze user engagement. For more information, see UserOverallReport.
Fields
name |
type |
|---|---|
createdAt |
TIMESTAMP |
photoUrl |
STRING |
hasPhoto |
BOOLEAN |
name |
STRING |
totalCustomersHelped |
NUMERIC |
id |
NUMERIC |
startDate |
TIMESTAMP |
endDate |
TIMESTAMP |
totalDays |
NUMERIC |
resolved |
NUMERIC |
conversationsCreated |
NUMERIC |
closed |
NUMERIC |
totalReplies |
NUMERIC |
resolvedOnFirstReply |
NUMERIC |
percentResolvedOnFirstReply |
NUMERIC |
handleTime |
NUMERIC |
happinessScore |
NUMERIC |
responseTime |
NUMERIC |
repliesPerDay |
NUMERIC |
averageFirstResponseTime |
NUMERIC |
customersHelped |
NUMERIC |
totalConversations |
NUMERIC |
conversationsPerDay |
NUMERIC |
busiestDay |
NUMERIC |
newConversations |
NUMERIC |
Users
Lists all user types for a Help Scout account. For more information, Users.
Fields
Field Name |
Data Type |
|---|---|
id |
NUMERIC |
firstName |
STRING |
lastName |
STRING |
email |
STRING |
role |
STRING |
timezone |
STRING |
photoUrl |
STRING |
createdAt |
TIMESTAMP |
updatedAt |
TIMESTAMP |
type |
STRING |
mention |
STRING |
initials |
STRING |
jobTitle |
STRING |
phone |
STRING |
_links |
RECORD |
Workflows
Workflows API lists workflows associated with specified mailbox Id. For more information, Workflows.
Fields
Field Name |
Data Type |
|---|---|
id |
NUMERIC |
mailboxId |
NUMERIC |
type |
STRING |
status |
STRING |
order |
NUMERIC |
name |
STRING |
createdAt |
TIMESTAMP |
modifiedAt |
TIMESTAMP |
_links |
RECORD |
