Freshdesk Ingestion Source
See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Freshdesk connector.
Data Source Configuration
Configure the data source parameters as explained below.
Fetch From Source/Upload Data File
To design the application, you can either fetch the sample data from the Freshdesk source by providing the data source connection details or upload a sample data file in one of the supported formats to see the schema details during the application design phase.
Upload Data File
To design the application, please upload a data file containing sample records in a format supported by Gathr.
The sample data provided for application design should match the data source schema from which data will be fetched during runtime.
If Upload Data File method is selected to design the application, provide the below details.
File Format
Select the format of the sample file depending on the file type.
Gathr-supported file formats for Freshdesk data sources are CSV, JSON, TEXT, Parquet and ORC.
For CSV file format, select its corresponding delimiter.
Header Included
Enable this option to read the first row as a header if your Freshdesk sample data file is in CSV format.
Upload
Please upload the sample file as per the file format selected above.
Fetch From Source
If Fetch From Source method is selected to design the application, then the data source connection details will be used to get sample data.
Continue to configure the data source.
Connection Name
Connections are the service identifiers. A connection name can be selected from the list if you have created and saved connection details for Freshdesk earlier. Or create one as explained in the topic - Freshdesk Connection →
Use the Test Connection option to ensure that the connection with the Freshdesk channel is established successfully.
A success message states that the connection is available. In case of any error in test connection, edit the connection to resolve the issue before proceeding further.
Entity
Tables in Freshdesk are statically defined to model Freshdesk entities.
If you selected the Fetch From Source method to design the application, the Entities will list as per the configured connection. Select the entity to be read from Freshdesk.
If you selected the Upload Data File method to design the application, the exact name of the entity should be provided to read the data from Freshdesk.
If you selected the Fetch From Source method to design the application, the Fields would list as per the Entity chosen in the previous configuration parameter. Select the fields or provide a custom query to read the desired records from Freshdesk.
Fields
The conditions to fetch source data from a Freshdesk table can be specified using this option.
Select Fields: Select the column(s) of the entity that should be read.
Custom Query: Provide an SQL query specifying the read conditions for the source data.
Example: SELECT "Id" FROM Companies
If you selected the Upload Data File method to design the application, provide a custom query to fetch records from the Freshdesk entity specified in the previous configuration.
Query
The conditions to fetch source data from a Freshdesk table can be specified using this option.
Provide an SQL query specifying the read conditions for the source data.
Example: SELECT "Id" FROM Companies
Read Options
This section contains additional configuration parameters.
Ignore Surplus Results
Use Ignore Surplus Results to ignore results beyond 300 which have same CreatedAt value.
By default, Freshdesk API only returns upto 300 results matching a specific filter.
The connector’s paging mechanism uses CreatedAt attribute as a filter, thus more than 300 results with same CreateAt value will cause the paging to fail.
Ignore Surplus Results will cause these surplus results to be ignored without causing an exception and keep retrieving results.
Ticket Stats
Use Tickets Stats to retrieve stats attributes of a ticket, which are not normally available.
When Ticket Stats is set to true, all requests (including filtering request) would be sent to the ‘List all’ endpoint. This would slightly affect the performance by handling filtering client-side, but would retrieve stats attributes of each ticket.
‘List all’ endpoint only retrieves the tickets created in the last 30 days.
Fetch Tickets Updated Since
Use Fetch Tickets Updated Since to query tickets older than 30 days.
When Ticket Stats is set to true, all requests (including filtering request) would be sent to the ‘List all’ endpoint. The ‘List all’ endpoint only retrieves the tickets created in the last 30 days, unless Fetch Tickets Updated Since is set to a specifed date.
Set Fetch Tickets Updated Since to a specified date to retrieve tickets created past the last 30 days. Examples:
Fetch Tickets Updated Since = 2022-01-01
Or,
Fetch Tickets Updated Since = 2022-01-01T00:00:00Z
Ticket Properties URL
Use Ticket Properties URL to query ticket properties.
Set Ticket Properties URL to the API URL that is found on the Schedule page of the created Scheduled Export. To find this, go to: Reports > Schedule an export > Click on the name of the Schedule and the URL is under the Receive via API section.
Partitioning
This section contains partitioning-related configuration parameters.
Enable Partitioning
This enables parallel reading of the data from the entity.
Partitioning is disabled by default.
If enabled, an additional option will appear to configure the partitioning conditions.
Column
The selected column will be used to partition the data.
Max Rows per Partition: Enter the maximum number of rows to be read in a single request.
Example: 10,000
It implies that a maximum number of 10,000 rows can be read in one partition.
Advanced Configuration
This section contains additional configuration parameters.
Fetch Size
The fetch size determines the number of rows to be fetched per round trip. The default value is 1000.
Add Configuration: Additional properties can be added using this option as key-value pairs.
Schema
Check the populated schema details. For more details, see Schema Preview →
If you have any feedback on Gathr documentation, please email us!