HelpScout Tables
The provider models the data in API as a list of tables in a relational database that can be queried using standard SQL statements.
HelpScout Tables
| Name | Description |
| Categories | Generates the single or list of categories. |
| CategoryArticles | Returns articles for a specific category. |
| CollectionArticles | Returns articles for a specific collection. |
| Collections | Generates single or list of collections. |
| CompanyCustomersHelpedReport | List of customer who want helps by company |
| CompanyDrillDownReport | This report is drills down and returns the conversation data that makes up the Conversations Report. |
| CompanyOverallReport | Gives the overall report of company. |
| Conversations | List and filter conversations. Use the thread resource link inside the Conversation entity to load conversation threads. |
| ConversationsBusiestTimeReport | Getting list of conversations busiest time report. |
| ConversationsDrillDownByFieldsReport | 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 | 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 | 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 | The new conversations report provides a summary of new conversation volume over a given time range. |
| ConversationsOverallReport | 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 | 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 | Getting list of conversations busiest time report. |
| CustomerAddress | Get Address of customer |
| CustomerChatHandles | List Chats Handles of Particular customer. |
| CustomerEmails | List Emails of customers |
| CustomerPhones | List Phones of customers |
| Customers | List Customers |
| CustomerSocialProfiles | List Social Profile of customers |
| CustomerWebsites | List of customerwebsites of customers |
| DocsOverallReport | 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 | 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 | The happiness ratings report provides a company's ratings for over a specified time range. |
| Mailboxes | List of Mailbox objects. |
| MailboxFolders | Gives list of folders in mailboxes |
| Me | Gives deatail about users(owner) account |
| ProductivityFirstResponseTimeReport | 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 | 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 | 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 | 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 | 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 | 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 | Retrives single or list of Redirects for a particular Site |
| Revisions | Retrives the single revision. |
| SearchArticles | Use this endpoint to search for articles or search for related articles. |
| Sites | Retrives single or list of Sites |
| Tags | Returns a list of tags used across all mailboxes. |
| Threads | Threads are by default sorted by createdAt (from newest to oldest). |
| UserConversationHistoryReport | The conversation history report provides details about a user's conversations for over a specified time range. |
| UserCustomerHelpedReport | 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 | 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 | The user ratings report provides a user's ratings for over a specified time range. |
| UserHappinessReport | 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 | 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 | 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 | 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. |
| Users | Gives list of Users |
| Webhooks | List of webhooks |
| Workflows | List of workflows |