Reference

Endpoint Read Tickets (Incremental) changed after a specified date

Name

get_tickets_incr

Description

Get a list of tickets changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [API reference]

Parameters

Parameter

Required

Options

Name: start_time

Label: Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)

Start DateTime for data fetch. Records modified after this date/time is fetched. You can enter date in yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. You can also use functions to get date. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start), now-5h (current time minus 5 hours), today-1m (today minus one month)

YES

Option	Value
now	now
now-5h	now-5h
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2022-01-31	2022-01-31
2022-01-31 23:59:59	2022-01-31 23:59:59

Name: exclude_deleted

Label: Exclude Deleted

Whether or not you'd like to exclude deleted tickets from the response

Option	Value
true	true
false	false

Name: per_page

Label: Page Size (Default 1000)

Number of results to return per page, up to a maximum of 1,000. If the parameter is not specified, the default number is 1,000.

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length
id	`DT_I8`	`bigint`
recipient	`DT_WSTR`	`nvarchar(255)`	255
subject	`DT_WSTR`	`nvarchar(1000)`	1000
status	`DT_WSTR`	`nvarchar(28)`	28
type	`DT_WSTR`	`nvarchar(255)`	255
priority	`DT_WSTR`	`nvarchar(24)`	24
description	`DT_NTEXT`	`nvarchar(MAX)`
external_id	`DT_WSTR`	`nvarchar(255)`	255
created_at	`DT_DBTIMESTAMP`	`datetime`
updated_at	`DT_DBTIMESTAMP`	`datetime`
raw_subject	`DT_WSTR`	`nvarchar(1000)`	1000
url	`DT_WSTR`	`nvarchar(500)`	500
comment_count	`DT_I8`	`bigint`
requester_id	`DT_I8`	`bigint`
submitter_id	`DT_I8`	`bigint`
assignee_id	`DT_I8`	`bigint`
organization_id	`DT_I8`	`bigint`
group_id	`DT_I8`	`bigint`
collaborator_ids	`DT_WSTR`	`nvarchar(1000)`	1000
collaborator_ids_1	`DT_WSTR`	`nvarchar(20)`	20
collaborator_ids_2	`DT_WSTR`	`nvarchar(20)`	20
collaborator_ids_3	`DT_WSTR`	`nvarchar(20)`	20
follower_ids	`DT_WSTR`	`nvarchar(1000)`	1000
follower_ids_1	`DT_WSTR`	`nvarchar(20)`	20
follower_ids_2	`DT_WSTR`	`nvarchar(20)`	20
follower_ids_3	`DT_WSTR`	`nvarchar(20)`	20
email_cc_ids	`DT_WSTR`	`nvarchar(1000)`	1000
email_cc_ids_1	`DT_WSTR`	`nvarchar(20)`	20
email_cc_ids_2	`DT_WSTR`	`nvarchar(20)`	20
email_cc_ids_3	`DT_WSTR`	`nvarchar(20)`	20
forum_topic_id	`DT_WSTR`	`nvarchar(255)`	255
problem_id	`DT_WSTR`	`nvarchar(255)`	255
has_incidents	`DT_BOOL`	`bit`
is_public	`DT_BOOL`	`bit`
due_at	`DT_DBTIMESTAMP`	`datetime`
tags	`DT_WSTR`	`nvarchar(1000)`	1000
tags_1	`DT_WSTR`	`nvarchar(50)`	50
tags_2	`DT_WSTR`	`nvarchar(50)`	50
tags_3	`DT_WSTR`	`nvarchar(50)`	50
tags_4	`DT_WSTR`	`nvarchar(50)`	50
tags_5	`DT_WSTR`	`nvarchar(50)`	50
custom_fields	`DT_WSTR`	`nvarchar(1000)`	1000
custom_fields_1_id	`DT_WSTR`	`nvarchar(20)`	20
custom_fields_1_value	`DT_WSTR`	`nvarchar(1000)`	1000
custom_fields_2_id	`DT_WSTR`	`nvarchar(20)`	20
custom_fields_2_value	`DT_WSTR`	`nvarchar(1000)`	1000
custom_fields_3_id	`DT_WSTR`	`nvarchar(20)`	20
custom_fields_3_value	`DT_WSTR`	`nvarchar(1000)`	1000
custom_fields_4_id	`DT_WSTR`	`nvarchar(20)`	20
custom_fields_4_value	`DT_WSTR`	`nvarchar(1000)`	1000
custom_fields_5_id	`DT_WSTR`	`nvarchar(20)`	20
custom_fields_5_value	`DT_WSTR`	`nvarchar(1000)`	1000
via_followup_source_id	`DT_I8`	`bigint`
satisfaction_rating_id	`DT_I8`	`bigint`
satisfaction_rating_score	`DT_WSTR`	`nvarchar(20)`	20
satisfaction_rating_comment	`DT_WSTR`	`nvarchar(1000)`	1000
sharing_agreement_ids	`DT_WSTR`	`nvarchar(255)`	255
fields	`DT_WSTR`	`nvarchar(1000)`	1000
followup_ids	`DT_WSTR`	`nvarchar(1000)`	1000
brand_id	`DT_I8`	`bigint`
allow_channelback	`DT_BOOL`	`bit`
allow_attachments	`DT_BOOL`	`bit`
via_channel	`DT_WSTR`	`nvarchar(100)`	100
via_source_rel	`DT_WSTR`	`nvarchar(255)`	255
via_source_from_address	`DT_WSTR`	`nvarchar(500)`	500
via_source_from_name	`DT_WSTR`	`nvarchar(500)`	500
via_source_to_name	`DT_WSTR`	`nvarchar(500)`	500
via_source_to_address	`DT_WSTR`	`nvarchar(500)`	500
via_source_from_ticket_id	`DT_I8`	`bigint`
via_source_from_subject	`DT_WSTR`	`nvarchar(1000)`	1000
via_source_from_channel	`DT_WSTR`	`nvarchar(50)`	50
custom_field_[$parent.id$]	`DT_WSTR`	`nvarchar(4000)`	4000

If the column you are looking for is missing, consider customizing Zendesk Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length
subject	`DT_WSTR`	`nvarchar(1012)`	1012
recipient	`DT_WSTR`	`nvarchar(255)`	255
status	`DT_WSTR`	`nvarchar(28)`	28
type	`DT_WSTR`	`nvarchar(255)`	255
priority	`DT_WSTR`	`nvarchar(24)`	24
comment_body	`DT_NTEXT`	`nvarchar(MAX)`
comment_body_html	`DT_NTEXT`	`nvarchar(MAX)`
comment_public	`DT_BOOL`	`bit`
comment_author_id	`DT_I8`	`bigint`
tags	`DT_WSTR`	`nvarchar(1000)`	1000
custom_fields	`DT_WSTR`	`nvarchar(1000)`	1000
external_id	`DT_WSTR`	`nvarchar(255)`	255
requester_name	`DT_WSTR`	`nvarchar(255)`	255
requester_email	`DT_WSTR`	`nvarchar(255)`	255
requester_id	`DT_I8`	`bigint`
submitter_id	`DT_I8`	`bigint`
assignee_id	`DT_I8`	`bigint`
organization_id	`DT_I8`	`bigint`
group_id	`DT_I8`	`bigint`
collaborator_ids	`DT_WSTR`	`nvarchar(1000)`	1000
follower_ids	`DT_WSTR`	`nvarchar(1000)`	1000
email_cc_ids	`DT_WSTR`	`nvarchar(1000)`	1000
forum_topic_id	`DT_WSTR`	`nvarchar(255)`	255
problem_id	`DT_WSTR`	`nvarchar(255)`	255
is_public	`DT_BOOL`	`bit`
due_at	`DT_DBTIMESTAMP`	`datetime`
sharing_agreement_ids	`DT_WSTR`	`nvarchar(255)`	255
fields	`DT_WSTR`	`nvarchar(1000)`	1000
followup_ids	`DT_WSTR`	`nvarchar(1000)`	1000
brand_id	`DT_I8`	`bigint`
allow_channelback	`DT_BOOL`	`bit`
allow_attachments	`DT_BOOL`	`bit`

Required columns that you need to supply are bolded.

Examples

SSIS

Use Zendesk Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Zendesk

Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.

Zendesk

Read Tickets (Incremental) changed after a specified date

Required Parameters
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)	Fill-in the parameter...
Optional Parameters
Exclude Deleted
Page Size (Default 1000)
NextUrlAttributeOrExpr	$.after_url
NextUrlEndIndicator	true
StopIndicatorAttributeOrExpr	$.end_of_stream

SSIS API Source - Read from table or endpoint

API Destination

API Destination - Zendesk

Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.

Zendesk

Read Tickets (Incremental) changed after a specified date

Required Parameters
Start Time (e.g. yyyy-MM-dd -OR- yyyy-MM-ddTHH:mm:ss)	Fill-in the parameter...
Optional Parameters
Exclude Deleted
Page Size (Default 1000)
NextUrlAttributeOrExpr	$.after_url
NextUrlEndIndicator	true
StopIndicatorAttributeOrExpr	$.end_of_stream

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get all tickets (incremental) modified after ceratin date/time

Read tickets modified after ceratin date/time. This is incremental data fetch. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option in the target. Only choose Update + Insert for Incremental fetch.

SELECT * FROM get_tickets_incr
WITH(
	    start_time='2012-01-31T00:00:00' --modified after exact date / time (yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)
		
	  --start_time='yesterday' --modified after yesterday
	  --start_time='now-5h' --modified after current time minus 5 hours
	  --start_time='today-60s' --modified after today minus 60 seconds
	  --start_time='weekstart' --modified after weekstart
	  --start_time='monthstart-1d' --modified after month start minus 1 day
	  --start_time='yearstart-1d' --modified after year start minus 1 day
	  --start_time='yearstart+1d' --modified after year start plus 1 day
	  --start_time='yearend+1d' --modified after year end plus 1 day
)

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get all tickets (incremental) modified after ceratin date/time

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_tickets_incr
WITH(
	    start_time=''2012-01-31T00:00:00'' --modified after exact date / time (yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)
		
	  --start_time=''yesterday'' --modified after yesterday
	  --start_time=''now-5h'' --modified after current time minus 5 hours
	  --start_time=''today-60s'' --modified after today minus 60 seconds
	  --start_time=''weekstart'' --modified after weekstart
	  --start_time=''monthstart-1d'' --modified after month start minus 1 day
	  --start_time=''yearstart-1d'' --modified after year start minus 1 day
	  --start_time=''yearstart+1d'' --modified after year start plus 1 day
	  --start_time=''yearend+1d'' --modified after year end plus 1 day
)';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];