Download Helpshift Email API
Author: c | 2025-04-24
Guides and references to help you integrate the Helpshift SDK into your app Refer to the Helpshift docs for Email support. APIs. REST API. Refer to the Helpshift
helpshift/helpshift-api: Wrappers for the Helpshift API - GitHub
Helpshift Analytics concept: Overview Helpshift Analytics allow you to improve the support experience for users and optimize the workflow for your team. Every organization u... Power BI 101 concept: Overview This guide is for first time users of Power BI who have already activated and installed Power BI. If you have Power BI activated but ha... Helpshift Analytics concept: How do I use the Analytics API? Our Analytics API allows you to load your analytics data in a 3rd party BI tool, such as Qlik or Tableau. With this API, you can do the foll... Helpshift Analytics concept: What can I see in the Analytics Dashboard? The Analytics Dashboard is designed to give you an overview of metrics for each of your applications by Issue type, volume, and te... Helpshift Analytics: What metrics can I use to analyze my FAQs? You can review information on FAQ effectiveness in your Helpshift Analytics Dashboard and in Power BI. To learn more about using P... Helpshift Analytics: What time do my Analytics metrics update daily? Our Analytics pages update at different times. The data on the Overview, Issues, and Team tabs refresh every 60 minutes.... Helpshift Analytics: How do I review or change my time zone setting in the Dashboard? Note: it is not possible to change your time zone at the domain level. You can only change it for your individual account.You can review and... Helpshift Analytics: How do I export Helpshift Analytics data? To export Helpshift Analytics data, navigate to the Helpshift Analytics page.Next, navigate to the page you wish to export data for using th... Helpshift Analytics: How is ‘Contact Rate’ defined/calculated? In Helpshift Analytics, the Contact Rate is calculated by the following formula:[(issues reported #, divided by MAU #) multiplied ... Helpshift Analytics: How do I filter for web & email Issues in my analytics data? You can filter for web & email Issues in both Helpshift Analytics and Power BI as follows:Helpshift AnalyticsHelpshift Analytics allows ... Helpshift Analytics: Under what conditions is an Issue ‘Resolved by Automation’ versus ‘Resolved by Agent’? In Helpshift Analytics and Power BI, if the current assignee is an Agent and the Issue is resolved by an Automation, it ... Helpshift Analytics: Bots Analytics API For Helpshift customers using Bots, Bots Analytics is now available through Helpshift Analytics APIs, and data can be downloaded as a .CSV f... Helpshift Analytics: Web FAQ Reports via Power BI and Analytics API Understand the performance of your Web FAQs using the new Web FAQs Report available through the Helpshift Power BI FAQ Analytics a... Helpshift Analytics: What metrics are available for evaluating Agent performance? You can find information on Agent performance via the Analytics Dashboard by reviewing
Helpshift APIs - Helpshift for Android
Rep... Power BI: Glossary NOTE: Web/ Email cases are treated as separate apps in reports and are not counted against any specific app. This is consistent across Helps... Analytics API Glossary NOTE: Web/ Email cases are treated as separate apps in reports and are not counted against any specific app. This is consistent across Helps... Helpshift Analytics: Quick Search Bot Analytics QuickSearch Bot is an AI-powered bot for your web and in-app messaging experience. It responds automatically to the end user's first message... Helpshift Analytics: Network prerequisites for Analytics Dashboard Before accessing the Analytics Dashboard, please verify the following:Firewall Rules (If applicable)Customers using the analytics dashboard ... Agent workload Visualization: A valuable resource for workforce capacity planning Helpshift Agent Dashboard helps your customer service and support agents to engage with your consumers in real time, sometimes helping sever... Helpshift Analytics: Usage Report Glossary The "Usage Report" serves as a vital tool for customers, offering a comprehensive view of their support journey. It provides monthly usage d... Helpshift Analytics: Intent Analytics The information on Intent analytics is available under the Intents section and is organized into two reports:Trends Summary by Intents Metri... Helpshift Foundational Analytics: Language AI Agent Translation Analytics The Language AI Agent Translations Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analyti... Helpshift Foundational Analytics: Feedback Bot Analytics The Feedback Bot Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analytics” section.Metric... Helpshift Foundational Analytics: AI-powered Answer Analytics The AI-powered Answer Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analytics” section.&... Helpshift Foundational Analytics: Sentiment Analysis Analytics The Sentiment Analysis Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analytics” section.... Helpshift Foundational Analytics: Issue Summary Analytics The Issue Summary Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analytics” section. ... Helpshift Foundational Analytics: Suggest Response Analytics The Suggest Response Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analytics” section. M... Helpshift Foundational Analytics: Smart Compose Analytics The Smart Compose Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analytics” section. Metr...Helpshift APIs - Android - Helpshift for Unity
Your app/build.gradle file.repositories { //your other repositories flatDir { dirs 'libs' }}dependencies { // your other dependencies implementation 'com.android.support:design:28.0.0' implementation 'com.android.support:recyclerview-v7:28.0.0' implementation 'com.android.support:cardview-v7:28.0.0' implementation(name: 'Helpshift', ext:'aar')}Link Helpshift files in your project as source depending on your build system.Using CMakeUsing ndk-build# Add Helpshift files to CMakeLists.txt, under the Android dependencyif(ANDROID) list(APPEND GAME_SOURCE Classes/HelpshiftCocos2dx.cpp Classes/HelpshiftCocos2dxUser.cpp Classes/HelpshiftUtil.cpp ) list(APPEND GAME_HEADER Classes/HelpshiftCocos2dx.h Classes/HelpshiftCocos2dxUser.h Classes/HelpshiftUtil.h )Using Eclipse project (ANT build)To use the latest Cocos2dx plugin in your application, add a reference to the Helpshift Android SDK from the project.properties file of your Android application. With the release of version 5.0.0, the Helpshift Android plugin sets the Android target to 26. To use this plugin, set the target to android-26 in your application.Cocos2d-x v3.xandroid.library.reference.1=../helpshift-plugin-cocos2dx/v3.x/android/proj.android/sdk/Cocos2d-x v2.xandroid.library.reference.1=../helpshift-plugin-cocos2dx/v2.x/android/sdk/Add Helpshift files to makefile (Android.mk), under the LOCAL_SRC_FILES rule. For example:LOCAL_SRC_FILES := hellocpp/main.cpp \ ../../Classes/HelpshiftCocos2dx.cpp \ ../../Classes/HelpshiftUtil.cpp \ ../../Classes/HelpshiftCocos2dxUser.cppOpen AndroidManifest.xml located at helpshift-plugin-cocos2dx/v2.x/android/sdk/ and helpshift-plugin-cocos2dx/v3.x/android/sdk/ for Cocos2dx version 2.x and 3.x respectively. Look for ${applicationId} located in provider tag and replace it with the package name of your android app. As an example, if your appplication's package name is com.example.application, tag will now look like this: android:name="com.helpshift.support.providers.HelpshiftFileProvider" android:authorities="com.example.application.helpshift.fileprovider" android:exported="false" android:grantUriPermissions="true" > android:name="android.support.FILE_PROVIDER_PATHS" android:resource="@xml/hs__provider_paths" />Set the flag for manifestmerger.enabled to true in your project.properties file:manifestmerger.enabled=trueCopy the hs__data file from the sdk/assets/ directory to the assets directory of your Cocos2dx application.NoteHelpshift Cocos plugin version 1.4.0 and above is packaged with the required android support libs v23.4.0 and it is also tested with Android Nougat devices.If the developer wants to integrate android support libs 24.x, there are reported issues on pre-lolipop devices. Refer this blog and the issue here. Cocos ant build system does not support android build options for the vector changes introduced in 24.x version.As a result, the Helpshift Cocos plugin which is tested with 24.x support lib version, does not work. Guides and references to help you integrate the Helpshift SDK into your app Refer to the Helpshift docs for Email support. APIs. REST API. Refer to the HelpshiftHelpshift APIs - iOS - Helpshift for Unity
New PartnerYou can add new partners by clicking the ‘Add partner’ button under the Rest APIs text.A pop-up will appear where you can enter in the partner’s email address and select permission levels for the API Key.The idea of adding new partners is to give only those permissions (Read or Write) that are required for specific users or teams.Example: Your Analytics team may only need ‘Read’ permissions. Similarly, if content management team needs both Read & Write access, you can give them that. The advantage is that if the keys related to one particular partner are compromised, you can delete only those partners keys without impacting everyone in the organization.Adding or deleting the new key for partners works the same way as for default keys. However, unlike default keys, you can delete a partner, which in turn deletes and deactivates all associated keys.4. Understanding Different PermissionsThe different permissions are as follows:Read-only: With this access, you’ll only be able to view data but not edit the contents Write-only: This access will allow your partner to modify Helpshift API endpoints (such as issue details) Default Key: Read and write – this is the only key with both permissions 5. Deleting an API KeyIf you believe an API key has been compromised, or you no longer use the Helpshift integration that was accessing your account through a particular API key, you can disable that partner directly from the Settings page by clicking the gear icon next to the key, and then clicking ‘Delete Partner’ or ‘Delete Key’.6. What If I Accidentally Delete an API Key?Our Support team has your back in the event that an API key is accidentally deleted. Reach out to us on support@helpshift.com with details on what information needs to be recovered. We will respond within 24 hours with next steps.Please keep in mind that you can also view activity around API distribution and deletion in the ‘History’ section. Click the ‘View History’ button on the API Settings page to access this information.A pop-up will appear where you can review the API history for each key.To set up additional features and learn more about Helpshift best practices, please review our Knowledge Base.Helpshift APIs - Android - Helpshift for Xamarin
On pre-lollipop devices because of the Cocos ant and android build incompatibility.Initializing Helpshift in your appNoteUse Helpshift.install(...); with the required arguments immediately after the super.onCreate() of your Cocos2d-xActivity.Helpshift SDK uniquely identifies your App with the combination of:API KeyYour unique developer API Key.Domain NameYour Helpshift domain name. For example : foo.helpshift.comApp IDA unique ID assigned to your app.To get the API Key, Domain Name and the App ID, navigate to Settings>SDK (for Developers) in your agent dashboard and scroll down to "Initializing Helpshift" section. Select your App from the dropdown and copy the three tokens to be passed when initializing Helpshift.Initialize Helpshift by importing com.helpshift.HelpshiftBridge andcalling the HelpshiftBridge.install in the onCreate of your Cocos2dxActivity: import com.helpshift.HelpshiftBridge; import com.helpshift.exceptions.InstallException; public class MyActivity extends Cocos2dxActivity { @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); try { HelpshiftBridge.install(this, "YOUR_API_KEY", "YOUR_DOMAIN_NAME", "YOUR_APP_ID"); } catch (InstallException e) { Log.e(TAG, "invalid install credentials : ", e); } } }Start using HelpshiftHelpshift is now integrated in your app. You should now use the support APIs to present FAQ or conversation screens inside your app.Run your app, and try starting a test conversation using the showConversation API call.Then goto your Helpshift agent dashboard and reply to experience the in-app messaging.Sample usage for FAQs and conversation APIs: // Presenting FAQs to your customers void GameSettingsScene::menuHelpCallback(CCObject* pSender) { HelpshiftCocos2dx::showFAQs(); } // Starting a conversation with your customers void GameSettingsScene::menuConversationCallback(CCObject* pSender) { HelpshiftCocos2dx::showConversation(); }Flickering issues with Cocos2d-x 2.xCocos2d-x v2.x has a bug which causes the screen to flicker when a dialog Activity is shown on top of it.If you integrate Helpshift SDK for Cocos2d-x, you will see a flicker in your app when the Review Reminder dialog is shown.To fix the bug, please apply the patch described on github.Helpshift APIs - Helpshift SDK X for Android
Report, review the s... Power BI: How do I add user ID data into Power BI? To pull in User ID data into your Power BI reports, first switch from Reading View to Editing View by clicking the ‘Edit report’ button at t... Power BI: Is it possible to set up ‘alerts’ for spikes in Issue volume? Spikes in Issue volume can be tracked in Power BI, and you can set up alerts in Power BI for when certain thresholds are met. To learn more,... Power BI: How do I filter data by 15 or 30 minute increments in Power BI? To update your Power BI reports to show metrics in 15 or 30 minute increments, complete the following steps:1. In the Support Analytics cont... Power BI: How do I install Helpshift Template Apps in Power BI? Helpshift Template App is a replacement for the current content pack. You can search and download Helpshift Template Apps from the AppS... Power BI: Power BI Reports Overview The purpose of this guide is to walk existing Helpshift + Power BI users through best practices for reviewing for the data available o... Power BI: How do I make use of Custom Issue Fields in Power BI? Once you’ve enabled Custom Issue Fields for reporting in Power BI, you’ll see them become available in the Custom Issue Fields Mapping page ... Power BI: How do I enable Custom Issue Fields for reporting in Power BI? Before you can use Custom Issue Fields in Power BI, they must first be enabled for reporting in your Helpshift Dashboard.Why are Custom Issu... Helpshift Analytics: Dashboard Analytics Glossary NOTE: The date filter in reports is based on the action time of the action related to the metric. For example:If you select "Last 7 Day... Helpshift Analytics: Dashboard Analytics Guide Note:Recommended to be viewed on more than 1600 x 900 pixels resolution screen.Data on all the tabs pages refresh every 12 hours.Please ensu... Helpshift Analytics: Overview The Overview page of the Analytics Dashboard allows you to review the summary of the key metrics. The page provides metric values and trends... Helpshift Analytics: Evaluating Issue Analytics The information on Issue level analytics is available under the Issues section, organized into five reports:Trends Summary by Platforms Summ... Helpshift Analytics: Evaluating Agent Metrics A wealth of information on Agent performance is available under the Team section, organized into four reports:Trends(Overall) Trends(Workloa... Helpshift Analytics: Measuring FAQ Effectiveness The information on FAQ effectiveness via the Analytics Dashboard is available under the FAQ section, organized into three reports:Trend... Helpshift Analytics: Tag Analytics The information on Issue volume by tags is available under the Tags tab, organized into two areas:Tags Download Tags report. In the Tags. Guides and references to help you integrate the Helpshift SDK into your app Refer to the Helpshift docs for Email support. APIs. REST API. Refer to the HelpshiftComments
Helpshift Analytics concept: Overview Helpshift Analytics allow you to improve the support experience for users and optimize the workflow for your team. Every organization u... Power BI 101 concept: Overview This guide is for first time users of Power BI who have already activated and installed Power BI. If you have Power BI activated but ha... Helpshift Analytics concept: How do I use the Analytics API? Our Analytics API allows you to load your analytics data in a 3rd party BI tool, such as Qlik or Tableau. With this API, you can do the foll... Helpshift Analytics concept: What can I see in the Analytics Dashboard? The Analytics Dashboard is designed to give you an overview of metrics for each of your applications by Issue type, volume, and te... Helpshift Analytics: What metrics can I use to analyze my FAQs? You can review information on FAQ effectiveness in your Helpshift Analytics Dashboard and in Power BI. To learn more about using P... Helpshift Analytics: What time do my Analytics metrics update daily? Our Analytics pages update at different times. The data on the Overview, Issues, and Team tabs refresh every 60 minutes.... Helpshift Analytics: How do I review or change my time zone setting in the Dashboard? Note: it is not possible to change your time zone at the domain level. You can only change it for your individual account.You can review and... Helpshift Analytics: How do I export Helpshift Analytics data? To export Helpshift Analytics data, navigate to the Helpshift Analytics page.Next, navigate to the page you wish to export data for using th... Helpshift Analytics: How is ‘Contact Rate’ defined/calculated? In Helpshift Analytics, the Contact Rate is calculated by the following formula:[(issues reported #, divided by MAU #) multiplied ... Helpshift Analytics: How do I filter for web & email Issues in my analytics data? You can filter for web & email Issues in both Helpshift Analytics and Power BI as follows:Helpshift AnalyticsHelpshift Analytics allows ... Helpshift Analytics: Under what conditions is an Issue ‘Resolved by Automation’ versus ‘Resolved by Agent’? In Helpshift Analytics and Power BI, if the current assignee is an Agent and the Issue is resolved by an Automation, it ... Helpshift Analytics: Bots Analytics API For Helpshift customers using Bots, Bots Analytics is now available through Helpshift Analytics APIs, and data can be downloaded as a .CSV f... Helpshift Analytics: Web FAQ Reports via Power BI and Analytics API Understand the performance of your Web FAQs using the new Web FAQs Report available through the Helpshift Power BI FAQ Analytics a... Helpshift Analytics: What metrics are available for evaluating Agent performance? You can find information on Agent performance via the Analytics Dashboard by reviewing
2025-04-20Rep... Power BI: Glossary NOTE: Web/ Email cases are treated as separate apps in reports and are not counted against any specific app. This is consistent across Helps... Analytics API Glossary NOTE: Web/ Email cases are treated as separate apps in reports and are not counted against any specific app. This is consistent across Helps... Helpshift Analytics: Quick Search Bot Analytics QuickSearch Bot is an AI-powered bot for your web and in-app messaging experience. It responds automatically to the end user's first message... Helpshift Analytics: Network prerequisites for Analytics Dashboard Before accessing the Analytics Dashboard, please verify the following:Firewall Rules (If applicable)Customers using the analytics dashboard ... Agent workload Visualization: A valuable resource for workforce capacity planning Helpshift Agent Dashboard helps your customer service and support agents to engage with your consumers in real time, sometimes helping sever... Helpshift Analytics: Usage Report Glossary The "Usage Report" serves as a vital tool for customers, offering a comprehensive view of their support journey. It provides monthly usage d... Helpshift Analytics: Intent Analytics The information on Intent analytics is available under the Intents section and is organized into two reports:Trends Summary by Intents Metri... Helpshift Foundational Analytics: Language AI Agent Translation Analytics The Language AI Agent Translations Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analyti... Helpshift Foundational Analytics: Feedback Bot Analytics The Feedback Bot Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analytics” section.Metric... Helpshift Foundational Analytics: AI-powered Answer Analytics The AI-powered Answer Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analytics” section.&... Helpshift Foundational Analytics: Sentiment Analysis Analytics The Sentiment Analysis Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analytics” section.... Helpshift Foundational Analytics: Issue Summary Analytics The Issue Summary Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analytics” section. ... Helpshift Foundational Analytics: Suggest Response Analytics The Suggest Response Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analytics” section. M... Helpshift Foundational Analytics: Smart Compose Analytics The Smart Compose Analytics report is available under the “Feature Performance - Issues” group in the “Foundational Analytics” section. Metr...
2025-04-16New PartnerYou can add new partners by clicking the ‘Add partner’ button under the Rest APIs text.A pop-up will appear where you can enter in the partner’s email address and select permission levels for the API Key.The idea of adding new partners is to give only those permissions (Read or Write) that are required for specific users or teams.Example: Your Analytics team may only need ‘Read’ permissions. Similarly, if content management team needs both Read & Write access, you can give them that. The advantage is that if the keys related to one particular partner are compromised, you can delete only those partners keys without impacting everyone in the organization.Adding or deleting the new key for partners works the same way as for default keys. However, unlike default keys, you can delete a partner, which in turn deletes and deactivates all associated keys.4. Understanding Different PermissionsThe different permissions are as follows:Read-only: With this access, you’ll only be able to view data but not edit the contents Write-only: This access will allow your partner to modify Helpshift API endpoints (such as issue details) Default Key: Read and write – this is the only key with both permissions 5. Deleting an API KeyIf you believe an API key has been compromised, or you no longer use the Helpshift integration that was accessing your account through a particular API key, you can disable that partner directly from the Settings page by clicking the gear icon next to the key, and then clicking ‘Delete Partner’ or ‘Delete Key’.6. What If I Accidentally Delete an API Key?Our Support team has your back in the event that an API key is accidentally deleted. Reach out to us on support@helpshift.com with details on what information needs to be recovered. We will respond within 24 hours with next steps.Please keep in mind that you can also view activity around API distribution and deletion in the ‘History’ section. Click the ‘View History’ button on the API Settings page to access this information.A pop-up will appear where you can review the API history for each key.To set up additional features and learn more about Helpshift best practices, please review our Knowledge Base.
2025-03-29On pre-lollipop devices because of the Cocos ant and android build incompatibility.Initializing Helpshift in your appNoteUse Helpshift.install(...); with the required arguments immediately after the super.onCreate() of your Cocos2d-xActivity.Helpshift SDK uniquely identifies your App with the combination of:API KeyYour unique developer API Key.Domain NameYour Helpshift domain name. For example : foo.helpshift.comApp IDA unique ID assigned to your app.To get the API Key, Domain Name and the App ID, navigate to Settings>SDK (for Developers) in your agent dashboard and scroll down to "Initializing Helpshift" section. Select your App from the dropdown and copy the three tokens to be passed when initializing Helpshift.Initialize Helpshift by importing com.helpshift.HelpshiftBridge andcalling the HelpshiftBridge.install in the onCreate of your Cocos2dxActivity: import com.helpshift.HelpshiftBridge; import com.helpshift.exceptions.InstallException; public class MyActivity extends Cocos2dxActivity { @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); try { HelpshiftBridge.install(this, "YOUR_API_KEY", "YOUR_DOMAIN_NAME", "YOUR_APP_ID"); } catch (InstallException e) { Log.e(TAG, "invalid install credentials : ", e); } } }Start using HelpshiftHelpshift is now integrated in your app. You should now use the support APIs to present FAQ or conversation screens inside your app.Run your app, and try starting a test conversation using the showConversation API call.Then goto your Helpshift agent dashboard and reply to experience the in-app messaging.Sample usage for FAQs and conversation APIs: // Presenting FAQs to your customers void GameSettingsScene::menuHelpCallback(CCObject* pSender) { HelpshiftCocos2dx::showFAQs(); } // Starting a conversation with your customers void GameSettingsScene::menuConversationCallback(CCObject* pSender) { HelpshiftCocos2dx::showConversation(); }Flickering issues with Cocos2d-x 2.xCocos2d-x v2.x has a bug which causes the screen to flicker when a dialog Activity is shown on top of it.If you integrate Helpshift SDK for Cocos2d-x, you will see a flicker in your app when the Review Reminder dialog is shown.To fix the bug, please apply the patch described on github.
2025-04-08