Zendesk Example - Search records using query expression (tickets, organization, users)
The ZappySys API Driver is a user-friendly interface designed to facilitate the seamless integration of various applications with the Zendesk API. With its intuitive design and robust functionality, the ZappySys API Driver simplifies the process of configuring specific API endpoints to efficiently read or write data from Zendesk.
Following examples shows how to Search records using query expression (tickets, organization, users) from Zendesk using ZappySys API Driver. You can explore additional examples for the Azure DevOps Connector here.
SELECT *
FROM get_search --limited to 1000 rows max
--OR
--FROM get_search_export --returns more than 1000 rows but no sorting or extra column allowed
WITH(
filtertype='', --can be ticket, organization, user, group. If you set here then no need to put in query (e.g. query='type:ticket ...'). This option is ignored for get_search_Export.
,sort_by='updated_at' --created_at, status, priority, ticket_type. This option is ignored for get_search_Export.
,sort_order='asc' --desc (not valid for get_search_export). This option is ignored for get_search_Export.
--read this for more information
--https://support.zendesk.com/hc/en-us/articles/4408883318554-Searching-users-groups-and-organizations
--https://support.zendesk.com/hc/en-us/articles/4408886879258-Zendesk-Support-search-reference#topic_crj_yev_uc
--https://support.zendesk.com/hc/en-us/articles/4408882086298-Searching-tickets
,query='type:ticket subject:"Upsert Destination"' --search tickets where subject contains phrase "Upsert Destination" (special characters like comma / dash etc ignored in match)
--,query='type:ticket 519872' --search ticket with id 519872
--,query='type:ticket tags:solved,odbc_powerpack updated>1months' --search tickets where two tags set solved,odbc_powerpack and updated in last one month
--,query='type:ticket -tags:odbc_powerpack updated>1months' --search tickets where where tags not like odbc_powerpack and updated in last one month
--,query='type:ticket status<solved created>1months' --search tickets with status not solved and created in last one month
--,query='type:ticket created:2014-08-01' --search tickets created on 2014-08-01 (UTC)
--,query='type:ticket created>2014-08-01T10:30:00Z created<2014-08-01T12:00:00Z' --search tickets created between two datetime (UTC time)
--,query='type:ticket requester:amy@mondocam.com' --search tickets where requester is amy@mondocam.com
--,query='type:ticket description:defective' --search tickets where decription contains word "defective"
--,query='type:ticket description:"product is defective"' --search tickets where decription contains phrase "product is defective"
--,query='type:ticket priority>low' --search tickets where priority greater than low (e.g. medium or high)"
--,query='ZappySys' --phrase match (no type): anywhere in ticket / organization / user contains ZappySys word - If filtertype parameter supplied then only those type included
--,query='ZappySys*' --phrase match (no type): wildcard usage
--,query='type:user "ZappySys"' --search users with term "ZappySys" anywhere in text properties
--,query='type:user email:"@zappysys"' --search users with term "@ZappySys.com" in email field
--,query='type:user name:"zappysys"' --search users with term "ZappySys" in name field
--,query='type:user details:"zappysys"' --search users with term "ZappySys" in details field
--,query='type:organization "ZappySys LLC"' --phrase match: organization name contains ZappySys LLC
)Microsoft SQL Server OPENQUERY Query - Zendesk Example
Following examples shows how to Search records using query expression (tickets, organization, users) in Microsoft SQL Server using OPENQUERY Query. This command facilitates the execution of pass-through queries on remote servers. Below example is demonstrating the usage of OPENQUERY.
SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME],
'SELECT *
FROM get_search --limited to 1000 rows max
--OR
--FROM get_search_export --returns more than 1000 rows but no sorting or extra column allowed
WITH(
filtertype='''', --can be ticket, organization, user, group. If you set here then no need to put in query (e.g. query=''type:ticket ...''). This option is ignored for get_search_Export.
,sort_by=''updated_at'' --created_at, status, priority, ticket_type. This option is ignored for get_search_Export.
,sort_order=''asc'' --desc (not valid for get_search_export). This option is ignored for get_search_Export.
--read this for more information
--https://support.zendesk.com/hc/en-us/articles/4408883318554-Searching-users-groups-and-organizations
--https://support.zendesk.com/hc/en-us/articles/4408886879258-Zendesk-Support-search-reference#topic_crj_yev_uc
--https://support.zendesk.com/hc/en-us/articles/4408882086298-Searching-tickets
,query=''type:ticket subject:"Upsert Destination"'' --search tickets where subject contains phrase "Upsert Destination" (special characters like comma / dash etc ignored in match)
--,query=''type:ticket 519872'' --search ticket with id 519872
--,query=''type:ticket tags:solved,odbc_powerpack updated>1months'' --search tickets where two tags set solved,odbc_powerpack and updated in last one month
--,query=''type:ticket -tags:odbc_powerpack updated>1months'' --search tickets where where tags not like odbc_powerpack and updated in last one month
--,query=''type:ticket status<solved created>1months'' --search tickets with status not solved and created in last one month
--,query=''type:ticket created:2014-08-01'' --search tickets created on 2014-08-01 (UTC)
--,query=''type:ticket created>2014-08-01T10:30:00Z created<2014-08-01T12:00:00Z'' --search tickets created between two datetime (UTC time)
--,query=''type:ticket requester:amy@mondocam.com'' --search tickets where requester is amy@mondocam.com
--,query=''type:ticket description:defective'' --search tickets where decription contains word "defective"
--,query=''type:ticket description:"product is defective"'' --search tickets where decription contains phrase "product is defective"
--,query=''type:ticket priority>low'' --search tickets where priority greater than low (e.g. medium or high)"
--,query=''ZappySys'' --phrase match (no type): anywhere in ticket / organization / user contains ZappySys word - If filtertype parameter supplied then only those type included
--,query=''ZappySys*'' --phrase match (no type): wildcard usage
--,query=''type:user "ZappySys"'' --search users with term "ZappySys" anywhere in text properties
--,query=''type:user email:"@zappysys"'' --search users with term "@ZappySys.com" in email field
--,query=''type:user name:"zappysys"'' --search users with term "ZappySys" in name field
--,query=''type:user details:"zappysys"'' --search users with term "ZappySys" in details field
--,query=''type:organization "ZappySys LLC"'' --phrase match: organization name contains ZappySys LLC
)');Microsoft SQL Server EXEC Query - Zendesk Example (Handling larger SQL text)
The major drawback of OPENQUERY is its inability to incorporate variables within SQL statements, which often leads to the use of cumbersome dynamic SQL (with numerous ticks and escape characters).
Fortunately, there is a solution. Starting with SQL 2005 and onwards, you can utilize the EXEC (your_sql) AT your_linked_server syntax. Following examples shows how to Search records using query expression (tickets, organization, users) in Microsoft SQL Server using EXEC Query.
DECLARE @MyQyery NVARCHAR(MAX) = 'SELECT *
FROM get_search --limited to 1000 rows max
--OR
--FROM get_search_export --returns more than 1000 rows but no sorting or extra column allowed
WITH(
filtertype='''', --can be ticket, organization, user, group. If you set here then no need to put in query (e.g. query=''type:ticket ...''). This option is ignored for get_search_Export.
,sort_by=''updated_at'' --created_at, status, priority, ticket_type. This option is ignored for get_search_Export.
,sort_order=''asc'' --desc (not valid for get_search_export). This option is ignored for get_search_Export.
--read this for more information
--https://support.zendesk.com/hc/en-us/articles/4408883318554-Searching-users-groups-and-organizations
--https://support.zendesk.com/hc/en-us/articles/4408886879258-Zendesk-Support-search-reference#topic_crj_yev_uc
--https://support.zendesk.com/hc/en-us/articles/4408882086298-Searching-tickets
,query=''type:ticket subject:"Upsert Destination"'' --search tickets where subject contains phrase "Upsert Destination" (special characters like comma / dash etc ignored in match)
--,query=''type:ticket 519872'' --search ticket with id 519872
--,query=''type:ticket tags:solved,odbc_powerpack updated>1months'' --search tickets where two tags set solved,odbc_powerpack and updated in last one month
--,query=''type:ticket -tags:odbc_powerpack updated>1months'' --search tickets where where tags not like odbc_powerpack and updated in last one month
--,query=''type:ticket status<solved created>1months'' --search tickets with status not solved and created in last one month
--,query=''type:ticket created:2014-08-01'' --search tickets created on 2014-08-01 (UTC)
--,query=''type:ticket created>2014-08-01T10:30:00Z created<2014-08-01T12:00:00Z'' --search tickets created between two datetime (UTC time)
--,query=''type:ticket requester:amy@mondocam.com'' --search tickets where requester is amy@mondocam.com
--,query=''type:ticket description:defective'' --search tickets where decription contains word "defective"
--,query=''type:ticket description:"product is defective"'' --search tickets where decription contains phrase "product is defective"
--,query=''type:ticket priority>low'' --search tickets where priority greater than low (e.g. medium or high)"
--,query=''ZappySys'' --phrase match (no type): anywhere in ticket / organization / user contains ZappySys word - If filtertype parameter supplied then only those type included
--,query=''ZappySys*'' --phrase match (no type): wildcard usage
--,query=''type:user "ZappySys"'' --search users with term "ZappySys" anywhere in text properties
--,query=''type:user email:"@zappysys"'' --search users with term "@ZappySys.com" in email field
--,query=''type:user name:"zappysys"'' --search users with term "ZappySys" in name field
--,query=''type:user details:"zappysys"'' --search users with term "ZappySys" in details field
--,query=''type:organization "ZappySys LLC"'' --phrase match: organization name contains ZappySys LLC
)';
EXE (@MyQyery) AT [MY_LINKED_SERVER_NAME];
Getting Started with Examples
ZappySys API Driver is a powerful software solution designed to facilitate the extraction and integration of data from a wide range of sources through APIs. Its intuitive design and extensive feature set make it an essential asset for any organization dealing with complex data integration tasks.
To get started with examples using ZappySys API Driver, please click on the following applications:
Key features of the ZappySys API Driver include:
The API ODBC driver facilitates the reading and writing of data from numerous popular online services (refer to the complete list here) using familiar SQL language without learning complexity of REST API calls. The driver allows querying nested structure and output as a flat table. You can also create your own ODBC / Data Gateway API connector file and use it with this driver.
Intuitive Configuration: The interface is designed to be user-friendly, enabling users to easily set up the specific API endpoints within Zendesk without requiring extensive technical expertise or programming knowledge.
Customizable Endpoint Setup: Users can conveniently configure the API endpoint settings, including the HTTP request method, endpoint URL, and any necessary parameters, to precisely target the desired data within Zendesk.
Data Manipulation Capabilities: The ZappySys API Driver allows for seamless data retrieval and writing, enabling users to fetch data from Zendesk and perform various data manipulation operations as needed, all through an intuitive and straightforward interface.
Secure Authentication Integration: The driver provides secure authentication integration, allowing users to securely connect to the Zendesk API by inputting the necessary authentication credentials, such as API tokens or other authentication keys.
Error Handling Support: The interface is equipped with comprehensive error handling support, ensuring that any errors or exceptions encountered during the data retrieval or writing process are efficiently managed and appropriately communicated to users for prompt resolution.
Data Visualization and Reporting: The ZappySys API Driver facilitates the seamless processing and presentation of the retrieved data from Zendesk, enabling users to generate comprehensive reports and visualizations for further analysis and decision-making purposes.
Overall, the ZappySys API Driver serves as a powerful tool for streamlining the integration of applications with Zendesk, providing users with a convenient and efficient way to access and manage data, all through a user-friendly and intuitive interface.