Please enable JavaScript to view this site.

Freshservice Forums

Freshservice API Data Model

Navigation: » No topics above this level «

Freshservice API SQL Driver

Invantive UniversalSQL is the fastest, easiest and most reliable way to exchange data with the Freshservice 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. Invantive Support or other users will try to help you.

itgen_freshservice_provider_description_text

The Freshservice driver covers 73 tables and 928 columns.

Freshservice API Clients

Invantive UniversalSQL is available on many user interfaces ("clients" in traditional server-client paradigma). All Invantive UniversalSQL statements can be exchanged with a close to 100% compatibility across all clients and operating systems (Windows, MacOS, Linux, iOS, Android).

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 Freshservice Power BI connector is based on the Invantive UniversalSQL driver for Freshservice, 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 Freshservice API into traditional databases such as SQL Server (on-premises and Azure), MySQL, PostgreSQL and Oracle is possible using Invantive Data Replicator. Invantive Data Replicator automatically creates and maintains Freshservice datawarehouses, possibly in combination with data from over 75 other (cloud) platforms. Invantive Data Replicator supports data volumes up to over 1 TB and over 5.000 companies. The on-premise edition of Invantive Bridge offers an Freshservice ADO.net provider.

Finally, online web apps can be build for Freshservice using App Online of Invantive Cloud.

Monitor API Calls

When a query or DML-statement has been executed on Invantive UniversalSQL a developer can evaluate the actual calls made to the Freshservice API using a query on sessionios@DataDictionary. As an alternative, extensive request and response logging can be enabled by setting log-native-calls-to-disk to true. In the %USERPROFILE%\Invantive\NativeLog folder Invantive UniversalSQL will create log files per Freshservice API request and response.

Specifications

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

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

The configuration can be changed using various attributes from the database definition, on log on and during 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 Freshservice the comparison of two texts is case sensitive by default.

Changes and bug fixes on the Freshservice SQL driver can be found in the release notes. Get access to the community through the Freshservice section of the Invantive forums.

Driver code for use in settings.xml: Freshservice

Alias: freshservice

Recommended alias: fdk

Driver code for use in settings.xml

AuthenticationAuthentication can be done using one of the following two alternatives:1. Using the user log on code, password and company also used on the Freshservice 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 '.freshservice.com' in the URL used to log on to Freshservice in a browser.The API key can be found in the 'Edit Profile' page in Freshservice, as described on https://support.freshservice.com/support/solutions/articles/225435-where-can-i-find-my-api-key.

API VersionThe V2 API of Freshservice is used. V1 APIs can be accessed using NativePlatformScalarRequests.

Usage LimitsInvantive SQL executes API calls to retrieve and upload data. The number of API calls allowed per hour depends on your Freshservice plan, API version and whether you have chosen for rate limits per minute (most recent) or hour (older). The V1 API default usage limit is 1.000 calls per hour. On V2 the limit is 3.000 (blossom, garden) or 5.000 (estate, forest) calls per hour. The new V2 limits are 100 (blossom), 200 (garden), 400 (estate) or 700 (forest) calls per minute. Increased limits can be purchased. 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'.

11-12-2024 09:11 Version 24.0.491-PROD+5130

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer