Reference

Endpoint Read Ticket Metric Events (Incremental) changed after a specified date


Name

get_ticket_metric_events_incr

Description

Get a list of Ticket Metric Events 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 Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.
If the column you are looking for is missing, consider customizing Zendesk Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

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 Ticket Metric Events (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)
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 Ticket Metric Events (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)
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:

Read ticket metric events changed after a specified date

SELECT * FROM get_ticket_metric_events_incr
WITH
(
    "start_time" = 'abcd-1234-start_time'
)

SQL Server

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

Read ticket metric events changed after a specified date

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_ticket_metric_events_incr
WITH
(
    "start_time" = ''abcd-1234-start_time''
)';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];