Please enable JavaScript to view this site.

Freshdesk API Data Model

Navigation: » No topics above this level «

Freshdesk API SQL Driver

Contents Previous Home Next More

Invantive SQL is the fastest, easiest and most reliable way to exchange data with the Freshdesk API.

Use the "Search" option in the left menu to search for a specific term such as the table or column description. When you already know the term, please use the "Index" option. When you can't find the information needed, please click on the Chat button at the bottom or place your question in the user community. Other users or Invantive Support will try to help you to our best.

Freshdesk is a cloud solution for customer management. Freshdesk includes CRM as well as tickets. Existing functionality of Freshdesk can be extended by custom fields.

Freshdesk API Clients

Invantive SQL is available on many user interfaces ("clients" in traditional server-client paradigma). The clients include Microsoft Excel, Microsoft Power BI, Microsoft Power Query, Microsoft Word and Microsoft Outlook. Web-based clients include Invantive Cloud, Invantive Bridge Online as OData proxy, Invantive App Online for interactive apps, Online SQL Editor for query execution and Invantive Data Access Point as extended proxy. The Freshdesk Power BI connector is based on the Invantive SQL driver for Freshdesk, completed by a high-performance OData connector which works straight on Power BI without any add-on. The OData protocol is always version 4, independent whether the backing platform uses OData, SOAP or another protocol. For technical users there are command-line editions of Invantive Data Hub running on iOS, Android, Windows, MacOS and Linux. Invantive Data Hub is also often used for enterprise server applications such as ETL. High-volume replication of data taken from the Freshdesk API into traditional databases such as SQL Server (on-premise and Azure), MySQL, PostgreSQL and Oracle is possible using Invantive Data Replicator. Invantive Data Replicator automatically creates and maintains Freshdesk datawarehouses, possibly in combination with data from over 70 other (cloud) platforms. Data Replicator supports data volumes up to over 1 TB and over 5.000 companies. Finally, online web apps can be build for Freshdesk using App Online of Invantive Cloud. The on-premise edition of Invantive Bridge offers an Freshdesk ADO.net provider. All Invantive SQL statements can be exchanged with a close to 100% compatibility across all clients and operating systems (Windows, MacOS, Linux, iOS, Android).

Specifications

The SQL driver for Freshdesk does not support partitioning. Define one data container in a database for each company in Freshdesk to enable parallel access for data from multiple companies.

An introduction into the concepts of Invantive SQL such as databases, data containers and partitioning can be found in the Invantive SQL grammar.

The configuration can be changed using various attributes during log on and use. A full list of configuration options is listed in the driver attributes.

The catalog name is used to compose the full qualified name of an object like a table or view. The schema name is used to compose the full qualified name of an object like a table or view. On Freshdesk the comparison of two texts is case sensitive by default.

Changes and bug fixes on the Freshdesk SQL driver can be found in the release notes. There is currently no specific section on the Invantive forums for Freshdesk. Please reach out to other users of Freshdesk by leaving a question or contact request.

Driver code for use in settings.xml: Freshdesk

Alias: freshdesk

Recommended alias: fdk

More technical documentation as provided by the supplier of the Freshdesk API on the native APIconnection used can be found at http://developer.freshdesk.com/api/#quick-reference.

Documentation

Authentication

Authentication can be done using one of the following two alternatives:

1. Using the user log on code, password and company also used on the Freshdesk website.

2. Using an API key and company.

Authentication using user log on code and password is recommended for general use. The company is the name before '.freshdesk.com' in the URL used to log on to Freshdesk in a browser.

The API key can be found in the 'Edit Profile' page in Freshdesk, as described on https://support.freshdesk.com/support/solutions/articles/225435-where-can-i-find-my-api-key.

 

Usage Limits

Invantive SQL executes API calls to retrieve and upload data. The number of API calls allowed per hour depends on your Freshdesk plan. The default usage limits vary between 1.000 and 5.000 calls per hour. Invantive SQL ensures that within your session the number of calls allowed per hour is not exceeded.

To get an impression of how Invantive SQL translates into API calls, please query the data dictionary view 'sessionios', such as with 'select * from sessionios@datadictionary'.

12-12-2020 13:14 Version 20.1.301-BETA+3023