> For the complete documentation index, see [llms.txt](https://daton-sarasanalytics.gitbook.io/daton/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://daton-sarasanalytics.gitbook.io/daton/integrations/data-sources/advertising/helpscout-v2/schema-information.md).

# Schema Information

## Tables/APIs 

The following is the list of tables or APIs associated with the HelpScout connector:

* [ChatReport](#chatreport) 
* [CompanyOverallReport](#companyoverallreport) 
* [ConversationDrilldownReport](#conversationdrilldownreport) 
* [ConversationThreads](#conversationthreads) 
* [Conversations](#conversations) 
* [Customers](#customers) 
* [DocsOverallReport](#docsoverallreport) 
* [EmailReport](#emailreport) 
* [HappinessRatingsReport](#happinessratingsreport) 
* [Mailbox](#mailbox) 
* [PhoneReport](#phonereport) 
* [ProductivityOverallReport](#productivityoverallreport) 
* [Tags](#tags) 
* [Teams](#teams) 
* [UserHappinessReport](#userhappinessreport) 
* [UserOverallReport](#useroverallreport) 
* [Users](#users) 
* [Workflows](#workflows)

#### ChatReport 

Retrieves detailed reports and analytics related to chat interactions, helping to analyze chat performance and trends. For more information, see [ChatReport](https://developer.helpscout.com/mailbox-api/endpoints/reports/chat/).

{% hint style="info" %}
This table in Daton doesn't support any primary key.
{% endhint %}

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>current</td><td>RECORD</td></tr><tr><td>waitTime</td><td>RECORD</td></tr><tr><td>responseTime</td><td>RECORD</td></tr><tr><td>messagesPerChat</td><td>RECORD</td></tr><tr><td>duration</td><td>RECORD</td></tr></tbody></table>

#### CompanyOverallReport&#x20;

Provides an overview of the overall performance and metrics across the entire company or organization. For more information, see [CompanyOverallReport](https://developer.helpscout.com/mailbox-api/endpoints/reports/company/reports-company-overall/).

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>startDate</td><td>TIMESTAMP</td></tr><tr><td>endDate</td><td>TIMESTAMP</td></tr><tr><td>customersHelped</td><td>NUMERIC</td></tr><tr><td>closed</td><td>NUMERIC</td></tr><tr><td>totalReplies</td><td>NUMERIC</td></tr><tr><td>totalUsers</td><td>NUMERIC</td></tr><tr><td>totalDays</td><td>NUMERIC</td></tr><tr><td>repliesPerDayPerUser</td><td>BIGNUMERIC</td></tr><tr><td>repliesPerDay</td><td>BIGNUMERIC</td></tr><tr><td>resolvedPerDay</td><td>BIGNUMERIC</td></tr><tr><td>newConversationsPerDay</td><td>BIGNUMERIC</td></tr><tr><td>name</td><td>STRING</td></tr><tr><td>user</td><td>NUMERIC</td></tr><tr><td>handleTime</td><td>BIGNUMERIC</td></tr><tr><td>replies</td><td>NUMERIC</td></tr><tr><td>happinessScore</td><td>NUMERIC</td></tr></tbody></table>

#### ConversationDrilldownReport&#x20;

Offers in-depth insights into specific conversations, allowing a closer examination of communication details. For more information, see [ConversationDrilldownReport](https://developer.helpscout.com/mailbox-api/endpoints/reports/company/reports-company-drilldown/).

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>id</td><td>NUMERIC</td></tr><tr><td>number</td><td>NUMERIC</td></tr><tr><td>assignedName</td><td>STRING</td></tr><tr><td>assignedType</td><td>STRING</td></tr><tr><td>attachments</td><td>BOOLEAN</td></tr><tr><td>subject</td><td>STRING</td></tr><tr><td>status</td><td>STRING</td></tr><tr><td>threadCount</td><td>NUMERIC</td></tr><tr><td>preview</td><td>STRING</td></tr><tr><td>customerName</td><td>STRING</td></tr><tr><td>customerEmail</td><td>STRING</td></tr><tr><td>customerIds</td><td>STRING</td></tr><tr><td>tags</td><td>RECORD</td></tr><tr><td>modifiedAt</td><td>TIMESTAMP</td></tr><tr><td>type</td><td>STRING</td></tr><tr><td>waitingSince</td><td>TIMESTAMP</td></tr><tr><td>waitingSinceType</td><td>NUMERIC</td></tr><tr><td>closedAt</td><td>TIMESTAMP</td></tr><tr><td>mailboxid</td><td>NUMERIC</td></tr><tr><td>assignedid</td><td>NUMERIC</td></tr></tbody></table>

#### ConversationThreads&#x20;

Retrieves threads of conversations, enabling a comprehensive view of interactions and discussions. For more information, see [ConversationThreads](https://developer.helpscout.com/mailbox-api/endpoints/conversations/threads/chat/).

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>id</td><td>NUMERIC</td></tr><tr><td>type</td><td>STRING</td></tr><tr><td>status</td><td>STRING</td></tr><tr><td>action</td><td>RECORD</td></tr><tr><td>source</td><td>RECORD</td></tr><tr><td>createdBy</td><td>RECORD</td></tr><tr><td>createdAt</td><td>TIMESTAMP</td></tr><tr><td>_links</td><td>RECORD</td></tr></tbody></table>

#### Conversations&#x20;

Allows access to data and details of various conversations, facilitating management and analysis. For more information, see [Conversations](https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/).

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>id</td><td>NUMERIC</td></tr><tr><td>number</td><td>NUMERIC</td></tr><tr><td>threads</td><td>NUMERIC</td></tr><tr><td>type</td><td>STRING</td></tr><tr><td>folderId</td><td>NUMERIC</td></tr><tr><td>status</td><td>STRING</td></tr><tr><td>state</td><td>STRING</td></tr><tr><td>subject</td><td>STRING</td></tr><tr><td>preview</td><td>STRING</td></tr><tr><td>mailboxId</td><td>NUMERIC</td></tr><tr><td>createdBy</td><td>RECORD</td></tr><tr><td>createdAt</td><td>TIMESTAMP</td></tr><tr><td>closedBy</td><td>NUMERIC</td></tr><tr><td>closedByUser</td><td>RECORD</td></tr><tr><td>closedAt</td><td>TIMESTAMP</td></tr><tr><td>userUpdatedAt</td><td>TIMESTAMP</td></tr><tr><td>customerWaitingSince</td><td>RECORD</td></tr><tr><td>source</td><td>RECORD</td></tr><tr><td>tags</td><td>RECORD</td></tr><tr><td>primaryCustomer</td><td>RECORD</td></tr><tr><td>_embedded</td><td>RECORD</td></tr><tr><td>_links</td><td>RECORD</td></tr><tr><td>customFields</td><td>RECORD</td></tr><tr><td>assignee</td><td>RECORD</td></tr></tbody></table>

#### Customers&#x20;

Provides information about customers using the platform, aiding in customer relationship management. For more information, see [Customers](https://developer.helpscout.com/mailbox-api/endpoints/customers/list/).

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>id</td><td>NUMERIC</td></tr><tr><td>firstName</td><td>STRING</td></tr><tr><td>lastName</td><td>STRING</td></tr><tr><td>gender</td><td>STRING</td></tr><tr><td>photoType</td><td>STRING</td></tr><tr><td>photoUrl</td><td>STRING</td></tr><tr><td>createdAt</td><td>TIMESTAMP</td></tr><tr><td>updatedAt</td><td>TIMESTAMP</td></tr><tr><td>background</td><td>STRING</td></tr><tr><td>draft</td><td>BOOLEAN</td></tr><tr><td>_embedded</td><td>RECORD</td></tr><tr><td>_links</td><td>RECORD</td></tr></tbody></table>

#### DocsOverallReport&#x20;

Offers an overview of documentation performance and analytics, helping to improve user support. For more information, see [DocsOverallReport](https://developer.helpscout.com/mailbox-api/endpoints/reports/docs/reports-docs-overall/).

{% hint style="info" %}
This table in Daton doesn't support any primary key.
{% endhint %}

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>current</td><td>RECORD</td></tr><tr><td>topArticles</td><td>RECORD</td></tr><tr><td>topCategories</td><td>RECORD</td></tr><tr><td>popularSearches</td><td>RECORD</td></tr><tr><td>failedSearches</td><td>RECORD</td></tr></tbody></table>

#### EmailReport&#x20;

Retrieves data and insights from email communications, assisting in email performance assessment. For more information, see [EmailReport](https://developer.helpscout.com/mailbox-api/endpoints/reports/email/).

{% hint style="info" %}
This table in Daton doesn't support any primary key.
{% endhint %}

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>current</td><td>RECORD</td></tr><tr><td>responseTime</td><td>RECORD</td></tr><tr><td>handleTime</td><td>RECORD</td></tr><tr><td>firstResponseTime</td><td>RECORD</td></tr><tr><td>resolutionTime</td><td>RECORD</td></tr><tr><td>repliesToResolve</td><td>RECORD</td></tr></tbody></table>

#### HappinessRatingsReport&#x20;

Provides reports on customer happiness ratings and feedback, aiding in user satisfaction analysis. For more information, see [HappinessRatingsReport](https://developer.helpscout.com/mailbox-api/endpoints/reports/happiness/reports-happiness-ratings/).

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>number</td><td>NUMERIC</td></tr><tr><td>threadid</td><td>NUMERIC</td></tr><tr><td>threadCreatedAt</td><td>TIMESTAMP</td></tr><tr><td>id</td><td>NUMERIC</td></tr><tr><td>type</td><td>STRING</td></tr><tr><td>ratingId</td><td>NUMERIC</td></tr><tr><td>ratingCustomerId</td><td>NUMERIC</td></tr><tr><td>ratingComments</td><td>STRING</td></tr><tr><td>ratingCreatedAt</td><td>TIMESTAMP</td></tr><tr><td>ratingCustomerName</td><td>STRING</td></tr><tr><td>ratingUserId</td><td>NUMERIC</td></tr><tr><td>ratingUserName</td><td>STRING</td></tr></tbody></table>

#### Mailbox&#x20;

Enables access to mailbox data, assisting in managing and organizing communication channels. For more information, see [Mailbox](https://developer.helpscout.com/mailbox-api/endpoints/mailboxes/list/).

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>id</td><td>NUMERIC</td></tr><tr><td>name</td><td>STRING</td></tr><tr><td>slug</td><td>STRING</td></tr><tr><td>email</td><td>STRING</td></tr><tr><td>createdAt</td><td>TIMESTAMP</td></tr><tr><td>updatedAt</td><td>TIMESTAMP</td></tr><tr><td>_links</td><td>RECORD</td></tr></tbody></table>

#### PhoneReport&#x20;

Retrieves reports and data from phone interactions, facilitating analysis of call performance. For more information, see [PhoneReport](https://developer.helpscout.com/mailbox-api/endpoints/reports/phone/).

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>startDate</td><td>TIMESTAMP</td></tr><tr><td>endDate</td><td>TIMESTAMP</td></tr><tr><td>phoneConversations</td><td>NUMERIC</td></tr><tr><td>phoneCallsCreated</td><td>NUMERIC</td></tr><tr><td>customers</td><td>NUMERIC</td></tr><tr><td>name</td><td>STRING</td></tr><tr><td>id</td><td>NUMERIC</td></tr><tr><td>current</td><td>RECORD</td></tr></tbody></table>

#### ProductivityOverallReport&#x20;

Offers an overview of productivity metrics and trends across the Help Scout account. For more infomation, see [ProductivityOverallReport](https://developer.helpscout.com/mailbox-api/endpoints/reports/productivity/reports-productivity-overall/).

{% hint style="info" %}
This table in Daton doesn't support any primary key.
{% endhint %}

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>current</td><td>RECORD</td></tr><tr><td>responseTime</td><td>RECORD</td></tr><tr><td>handleTime</td><td>RECORD</td></tr><tr><td>firstResponseTime</td><td>RECORD</td></tr><tr><td>resolutionTime</td><td>RECORD</td></tr><tr><td>repliesToResolve</td><td>RECORD</td></tr></tbody></table>

#### Tags&#x20;

Provides information about tags and their usage, aiding in categorization and organization. For more information, see [Tags](https://developer.helpscout.com/mailbox-api/endpoints/tags/get/).

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>id</td><td>NUMERIC</td></tr><tr><td>slug</td><td>STRING</td></tr><tr><td>name</td><td>STRING</td></tr><tr><td>color</td><td>STRING</td></tr><tr><td>createdAt</td><td>TIMESTAMP</td></tr><tr><td>ticketCount</td><td>NUMERIC</td></tr></tbody></table>

#### Teams&#x20;

Offers data about teams within the organization, assisting in team management. For more information, see [Teams](https://developer.helpscout.com/mailbox-api/endpoints/teams/list-team-members/).

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>id</td><td>NUMERIC</td></tr><tr><td>name</td><td>STRING</td></tr><tr><td>timezone</td><td>STRING</td></tr><tr><td>photoUrl</td><td>STRING</td></tr><tr><td>createdAt</td><td>TIMESTAMP</td></tr><tr><td>updatedAt</td><td>TIMESTAMP</td></tr><tr><td>mention</td><td>STRING</td></tr><tr><td>initials</td><td>STRING</td></tr><tr><td>_links</td><td>RECORD</td></tr></tbody></table>

#### UserHappinessReport&#x20;

Provides reports on user happiness ratings and feedback, aiding in user satisfaction assessment. For more information, see [UserHappinessReport](https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user-happiness/).

**Fields**

<table><thead><tr><th width="64">name</th><th width="64">type</th></tr></thead><tbody><tr><td>notGoodCount</td><td>NUMERIC</td></tr><tr><td>okay</td><td>NUMERIC</td></tr><tr><td>totalCustomers</td><td>NUMERIC</td></tr><tr><td>happinessScore</td><td>NUMERIC</td></tr><tr><td>totalConversationsWithRatings</td><td>NUMERIC</td></tr><tr><td>totalCustomersWithRatings</td><td>NUMERIC</td></tr><tr><td>ratingsCount</td><td>NUMERIC</td></tr><tr><td>ratingsPercent</td><td>BIGNUMERIC</td></tr><tr><td>notGood</td><td>NUMERIC</td></tr><tr><td>great</td><td>NUMERIC</td></tr><tr><td>greatCount</td><td>NUMERIC</td></tr><tr><td>okayCount</td><td>NUMERIC</td></tr><tr><td>userId</td><td>NUMERIC</td></tr></tbody></table>

#### UserOverallReport&#x20;

Offers an overview of user performance and metrics, helping to analyze user engagement. For more information, see [UserOverallReport](https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user/).

**Fields**

<table><thead><tr><th width="64">name</th><th width="64">type</th></tr></thead><tbody><tr><td>createdAt</td><td>TIMESTAMP</td></tr><tr><td>photoUrl</td><td>STRING</td></tr><tr><td>hasPhoto</td><td>BOOLEAN</td></tr><tr><td>name</td><td>STRING</td></tr><tr><td>totalCustomersHelped</td><td>NUMERIC</td></tr><tr><td>id</td><td>NUMERIC</td></tr><tr><td>startDate</td><td>TIMESTAMP</td></tr><tr><td>endDate</td><td>TIMESTAMP</td></tr><tr><td>totalDays</td><td>NUMERIC</td></tr><tr><td>resolved</td><td>NUMERIC</td></tr><tr><td>conversationsCreated</td><td>NUMERIC</td></tr><tr><td>closed</td><td>NUMERIC</td></tr><tr><td>totalReplies</td><td>NUMERIC</td></tr><tr><td>resolvedOnFirstReply</td><td>NUMERIC</td></tr><tr><td>percentResolvedOnFirstReply</td><td>NUMERIC</td></tr><tr><td>handleTime</td><td>NUMERIC</td></tr><tr><td>happinessScore</td><td>NUMERIC</td></tr><tr><td>responseTime</td><td>NUMERIC</td></tr><tr><td>repliesPerDay</td><td>NUMERIC</td></tr><tr><td>averageFirstResponseTime</td><td>NUMERIC</td></tr><tr><td>customersHelped</td><td>NUMERIC</td></tr><tr><td>totalConversations</td><td>NUMERIC</td></tr><tr><td>conversationsPerDay</td><td>NUMERIC</td></tr><tr><td>busiestDay</td><td>NUMERIC</td></tr><tr><td>newConversations</td><td>NUMERIC</td></tr></tbody></table>

#### Users&#x20;

Lists all user types for a Help Scout account. For more information, [Users](https://developer.helpscout.com/mailbox-api/endpoints/users/list/).

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>id</td><td>NUMERIC</td></tr><tr><td>firstName</td><td>STRING</td></tr><tr><td>lastName</td><td>STRING</td></tr><tr><td>email</td><td>STRING</td></tr><tr><td>role</td><td>STRING</td></tr><tr><td>timezone</td><td>STRING</td></tr><tr><td>photoUrl</td><td>STRING</td></tr><tr><td>createdAt</td><td>TIMESTAMP</td></tr><tr><td>updatedAt</td><td>TIMESTAMP</td></tr><tr><td>type</td><td>STRING</td></tr><tr><td>mention</td><td>STRING</td></tr><tr><td>initials</td><td>STRING</td></tr><tr><td>jobTitle</td><td>STRING</td></tr><tr><td>phone</td><td>STRING</td></tr><tr><td>_links</td><td>RECORD</td></tr></tbody></table>

#### Workflows

Workflows API lists workflows associated with specified mailbox Id. For more information,  [Workflows](https://developer.helpscout.com/mailbox-api/endpoints/workflows/list/).

**Fields**

<table><thead><tr><th width="64">Field Name</th><th width="64">Data Type</th></tr></thead><tbody><tr><td>id</td><td>NUMERIC</td></tr><tr><td>mailboxId</td><td>NUMERIC</td></tr><tr><td>type</td><td>STRING</td></tr><tr><td>status</td><td>STRING</td></tr><tr><td>order</td><td>NUMERIC</td></tr><tr><td>name</td><td>STRING</td></tr><tr><td>createdAt</td><td>TIMESTAMP</td></tr><tr><td>modifiedAt</td><td>TIMESTAMP</td></tr><tr><td>_links</td><td>RECORD</td></tr></tbody></table>