Overview
The Lyftron Provider for HelpScout offers the most natural way to access HelpScout data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing HelpScout data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s HelpScout data provider and automatically build your data migration pipelines in minutes, not months
The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.
Key Features
- Comprehensive Delta load mechanism.
- Real-time access to HelpScout.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for HelpScout, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron
Step1: Setup HelpScout account
1.1 Create account in HelpScout and login
1.2. After Login go to Profile → Authentication → click on -> New API Key to generate Api key
Establishing a Connection with Lyftron's Quickstart Steps
Create your HelpScout connection with Lyftron by following the easy steps show below:
Step2 : Login to Lyftron
Start creating your connection
Step2.1. Add your connection
Click on Connect section on the left panel → Click on Add Connection button In the connector selection panel, search and click HelpScout for your connection
Step2.2 Enter your connection details
In the Connection String section enter the values of the below parameters. The following connection string is required to establish HelpScout connection with Lyftron.
Profile=C:\profiles\HelpScout.apip;ProfileSettings='User=< API Key >;Password=< Dummy Password >;'Give connection name as Drip -> Replace “your_api_key” with DripApi-key, click on test connection -> click save. If connection is not successful so, check the error
| Key | Value | Field |
| Connection Name | Enter your connection details | Required |
| Profile | C:\profiles\HelpScout.apip | Required |
| User | your HelpScout API Key > | Required |
| Password | your HelpScout < Dummy Password > | Required |
| Logfile** | Use the logfile option to debug your job and provide your connection name to generate the log file. [ConnectionConfigurationPath]\Connection_name_log.tx | Optional |
| Verbosity** | Choose verbosity 1-5 based on the severity of debugging | Optional |
** For more information, check the Lyftron logging and debugging section.
If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.
Test your connection
Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.
Save your connection
Hurray! Now you have successfully connected with the Lyftron HelpScout connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.
Step3 : Normalize
Create data source
After establishing connection, datasource metadata import is needed and for that Lyftron automatically normalize your API & different SQL dialects data into ANSI SQL format and also gives you API sources into simple, code less out of the box data model.
3.1 Click on Normalize section from the left panel -> Click on Add Data Source button, Enter data source name -> Choose Drip from the existing connection list -> Click next
3.2 Choose the table you want to import and -> Click Create
Data Model
The provider models the data in APIs into a list of tables that can be queried using standard SQL statements.
Generally, querying APIs tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns.
| Name | Type | Description |
| Categories | Tables | Generates the single or list of categories. |
| Collections | Tables | Generates single or list of collections. |
| CompanyCustomersHelpedReport | Tables | List of customer who want helps by company |
| CompanyDrillDownReport | Tables | This report is drills down and returns the conversation data that makes up the Conversations Report. |
| CompanyOverallReport | Tables | Gives the overall report of company. |
| Conversations | Tables | List and filter conversations. Use the thread resource link inside the Conversation entity to load conversation threads. |
| ConversationsBusiestTimeReport | Tables | Getting list of conversations busiest time report. |
| ConversationsDrillDownByFieldsReport | Tables | 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. |
| ConversationsDrillDownReport | Tables | 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. |
| ConversationsNewConversationDrillDownReport | Tables | This report is similar to the New Conversations Report, but instead of returning statistics about new conversation volume, it drills down and returns the actual new conversations that makes up the New Conversations Report. |
| ConversationsNewConversationReport | Tables | The new conversations report provides a summary of new conversation volume over a given time range. |
| ConversationsOverallReport | Tables | The conversations report provides statistics about conversation volume over a given time range. You may optionally specify two time ranges to see how conversation volume changed between the two ranges. |
| ConversationsReceivedMessageStatisticReport | Tables | The received messages report provides a summary of the volume of received messages over a given time range. Only messages from customers are counted. |
| ConversationsVolumesByChannel | Tables | Getting list of conversations busiest time report. |
| CustomerAddress | Tables | Get Address of customer |
| CustomerChatHandles | Tables | List Chats Handles of Particular customer. |
| CustomerEmails | Tables | List Emails of customers |
| CustomerPhones | Tables | List Phones of customers |
| Customers | Tables | List Customers |
| CustomerSocialProfiles | Tables | List Social Profile of customers |
| CustomerWebsites | Tables | List of customerwebsites of customers |
| DocsOverallReport | Tables | The Docs report provides statistics about Docs usage (searches, top articles, etc.) over a given time range. You may optionally specify two time ranges to see how usage changed between the two ranges. |
| HappinessOverallReport | Tables | 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. You may optionally specify two time ranges to see how happiness ratings changed between the two time ranges. |
| HappinessRatingReport | Tables | The happiness ratings report provides a company's ratings for over a specified time range. |
| ListArticles | Tables | Articles can be with single article or listed by either a Collection or a Category. |
| Mailboxes | Tables | List of Mailbox objects. |
| MailboxFolders | Tables | Gives list of folders in mailboxes |
| Me | Tables | Gives deatail about users(owner) account |
| ProductivityFirstResponseTimeReport | Tables | This report provides average first response times for each period in a specified time range. You may optionally specify two time ranges to see how first response time changed between the two ranges. |
| ProductivityOverallReport | Tables | The productivity report provides a snapshot of productivity over a given time range. You may optionally specify two time ranges to see how productivity changed between the two ranges. |
| ProductivityRepliesSentReport | Tables | This report provides the number of replies sent for each period in a specified time range. You may optionally specify two time ranges to see how the number of replies sent changed between the two ranges. |
| ProductivityResolutionTimeReport | Tables | This report provides average resolution times for each period in a specified time range. You may optionally specify two time ranges to see how average resolution time changed between the two ranges. |
| ProductivityResolvedReport | Tables | This report provides the number of resolved conversations for each period in a specified time range. You may optionally specify two time ranges to see how the number of resolved conversations changed between the two ranges. |
| ProductivityResponseTimeReport | Tables | This report provides average response times for each period in a specified time range. You may optionally specify two time ranges to see how response time changed between the two ranges. |
| Redirects | Tables | Retrives single or list of Redirects for a particular Site |
| Revisions | Tables | Retrives the single revision. |
| SearchArticles | Tables | Use this endpoint to search for articles or search for related articles. |
| Sites | Tables | Retrives single or list of Sites |
| Tags | Tables | Returns a list of tags used across all mailboxes. |
| Threads | Tables | Threads are by default sorted by createdAt (from newest to oldest). |
| User | Tables | Gives list of Users |
| UserConversationHistoryReport | Tables | The conversation history report provides details about a user's conversations for over a specified time range. |
| UserCustomerHelpedReport | Tables | This reports provides the number of customers a user helped for each period in a specified time range. You may optionally specify two time ranges to see how the number of customers helped changed between the two time ranges. |
| UserDrillDownReport | Tables | 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. |
| UserHappinessDrillDownReport | Tables | The user ratings report provides a user's ratings for over a specified time range. |
| UserHappinessReport | Tables | 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. You may optionally specify two time ranges to see how happiness ratings changed between the two time ranges. |
| UserOverallReport | Tables | The report provides a snapshot of a user or team activity over a specified time range. You may optionally specify two time ranges to see how activity changed between the two ranges. |
| UserRepliesReport | Tables | This reports provides the number of replies a user sent for each period in a specified time range. You may optionally specify two time ranges to see how the number replies changed between the two time ranges. |
| UserResolutionReport | Tables | This reports provides the number of conversations a user helped resolve for each period in a specified time range. You may optionally specify two time ranges to see how the number of resolved conversations changed between the two time ranges. |
| Webhooks | Tables | List of webhooks |
| Workflows | Tables | List of workflows |
Step 4: Analyze
Querying the data source data
Lyftron allows you to query the source data by simply writing the ANSI Sql query. Please keep in mind as the data is coming directly from API so, there’s a limit to API calls and performance delay from the Stripe API side which Lyftron can’t control so, don’t expect to pull millions of records in just fraction of seconds. If you have heavy data loads, create the pipeline to unload that data into the Lyftron warehouse and query from it.
4.1. Click on the analyze section on the left panel -> Choose data source from the list. Drag and drop the table -> Choose your querying options
4.2. Click on -> EXECUTE and selected query will return data successfully
Advanced Settings
To view a detailed advanced settings options, go to HelpScout Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.