ex-freshdesk

Keboola Connection Extractor for Freshdesk.

Description

This is the documentation for a Keboola Connection extractor.

The extractor was created using the Freshdesk REST API; for additional information, check out its documentation.

The extractor is set to extract the table tickets using pagination with 100 tickets per page. Conversations are extracted per tickets and thus need the tickets table in the configuration and may exhaust the API request limit. When downloading tables tickets and conversations, a setting max_pages = 18 should generally not exhaust the API request limit.

Configuration

• Domain: The first part of your url on which the Freshdesk server is set up, for example: my_domain where my_domain.freshdesk.com is your web page.
• API Token: You can find this token in your profile settings on your Freshdesk web page.
• List of Tables: Choose which tables should be downloaded from the list.
• Tickets: The main table. Always uses filter updated_since.
  • Days Past: Fixed date in the format YYYY-MM-DD, dynamic number of days in the format N where N is a non-negative integer, or the word today. From this parameter, the extractor will compute a date in the format YYYY-MM-DD and add it to the updated_since filter as its value.
  • Max Pages: Default value is set to the API limit of 300 pages. In case you need to download historic data, use this parameter as a substitute for the to_date parameter missing in the API.
  • Incremental: Check the box if the data should be loaded to Keboola Storage incrementally.
  • Primary Keys: Names of the columns in the extracted table that you consider as primary keys.
  • Include: Choose additional data columns from the list. Caution: using this parameter consumes 2 additional API requests.
• Conversations: Conversations for each ticket cost one API request.
  • Incremental: Check the box if the data should be loaded to Keboola Storage incrementally.
  • Primary Keys: Names of the columns in the extracted table that you consider as primary keys.

Need help?

If you have any questions, feel free to contact us at support@revolt.bi, check our other solutions at our web page or find other components at Keboola Developer Portal.

Prepared by