HelpScout

Helpscout ETL connector for data replication

Snapshot

Tables/APIs Supported --- | --- Conversations | Customers Tags | ConversationsReceivedMessages ConversationsDrilldownReport | CompanyOverallReport ConversationsVolumesByChannelReport | DocsOverallReport CompanyConversationsReport | CustomerHappinessOverallReport ProductivityOverallReport | ConversationsOverallReport Users | Emailreport Chatreport | UserOverallReport UserConversationHistoryReport | UserConversationReport UserHappinessReport | UserHappinessDrilldown CustomerHappinessRatingsReport

Integrate Helpscout with Daton

Signin to Daton
Select Helpscout from Integrations page
Provide Integration Name Replication Frequency and History. Integration name would be used in creating tables for the integration and cannot be changed later
Provide your Helpscout account Email and Password.
After providing the Email,password to authorize Daton to periodically extract data from Helpscout.
Post successful authentication you will be prompted to choose from the list of available tables
Then select all required fields for each table
Submit the integration.

Workflow

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
Users would be able to edit/pause/re-activate/delete integration anytime
Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

Helpscout Data

Conversations

Purpose: List and filter conversations.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/conversations/list/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

Customers

Purpose:Request parameters can be used to filter customers.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/customers/list/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

Tags

Purpose:Returns a list of tags used across all mailboxes. Tags are returned in alphabetical order.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/tags/list/

Replication: Full Replication

Replication Key: NA

Fields

ConversationsReceivedMessages

Purpose: The received messages report provides a summary of the volume of received messages over a given time range. Only messages from customers are counted.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/conversations/reports-conversations-received-messages/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

ConversationsDrilldownReport

Purpose:This report is similar to the Conversations Report, but instead of returning statistics about conversation volume, it drills down and returns the conversation data that makes up the Conversations Report.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/conversations/reports-conversations-drilldown/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

CompanyOverallReport

Purpose: The company report provides statistics about your company performance over a given time range. You may optionally specify two time ranges to see how performance changed between the two ranges.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/company/reports-company-overall/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

ConversationsVolumesByChannelReport

Purpose:This report shows conversation volumes split by chat, phone and email channels.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/conversations/reports-conversations-volume-by-channel/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

DocsOverallReport

Purpose: The Docs report provides statistics about Docs usage (searches, top articles, etc.) over a given time range.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/docs/reports-docs-overall/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

CompanyConversationsReport

Purpose:This report is similar to the Company Report, but instead of returning statistics about the company, it drills down and returns the conversation data that makes up the Company Report.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/company/reports-company-drilldown/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

CustomerHappinessOverallReport

Purpose:The happiness report provides information about how many Great, Okay, and Not Good ratings your company received for each period in a specified time range.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/happiness/reports-happiness-overall/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

ProductivityOverallReport

Purpose: The productivity report provides a snapshot of productivity over a given time range.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/productivity/reports-productivity-overall/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

ConversationsOverallReport

Purpose:The conversations report provides statistics about conversation volume over a given time range.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/conversations/reports-conversations-overall/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

Users

Purpose: To get all the users.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/users/list/

Replication: Full Replication

Replication Key: NA

Fields

Emailreport

Purpose:Our Email report measures efficiency working with email conversations.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/email/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

Chatreport

Purpose:The Chat report is all about seeing volume, efficiency, and team productivity when using Beacon with live chat over time.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/chat/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

UserOverallReport

Purpose:The report provides a snapshot of a user or team activity over a specified time range.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

UserConversationHistoryReport

Purpose:The conversation history report provides details about a user’s conversations for over a specified time range.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user-conversation-history/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

UserConversationReport

Purpose:This report is similar to the User Report, but instead of returning statistics about users, it drills down and returns the conversation data that makes up the User Report.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user-drilldown/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

UserHappinessReport

Purpose:The happiness report provides information about how many Great, Okay, and Not Good ratings a user received for each period in a specified time range.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user-happiness/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

UserHappinessDrilldown

Purpose:The user ratings report provides a user’s ratings for over a specified time range.

Source API Documentation https://developer.helpscout.com/mailbox-api/endpoints/reports/user/reports-user-happiness-drilldown/

Replication: Key-Based Replication

Replication Key: lastRunDate

Fields

CustomerHappinessRatingsReport

Purpose:The happiness ratings report provides a company’s ratings for over a specified time range.