TCL / Support API / Incremental Ticket Export, Cursor Based
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "start_time" "<integer>"
CkJsonObject_UpdateString $queryParams "cursor" "<string>"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://example.zendesk.com/api/v2/incremental/tickets/cursor" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "after_cursor": "<string>",
# "after_url": "<string>",
# "before_cursor": "<string>",
# "before_url": "<string>",
# "end_of_stream": "<boolean>",
# "tickets": [
# {
# "requester_id": "<integer>",
# "allow_attachments": "<boolean>",
# "allow_channelback": "<boolean>",
# "assignee_email": "<string>",
# "assignee_id": "<integer>",
# "attribute_value_ids": "<array>",
# "brand_id": "<integer>",
# "collaborator_ids": "<array>",
# "collaborators": [
# {
# "email": "<email>",
# "name": "<string>"
# },
# {
# "email": "<email>",
# "name": "<string>"
# }
# ],
# "comment": {},
# "created_at": "<dateTime>",
# "custom_fields": "<array>",
# "custom_status_id": "<integer>",
# "description": "<string>",
# "due_at": "<dateTime>",
# "email_cc_ids": "<array>",
# "email_ccs": {},
# "external_id": "<string>",
# "follower_ids": "<array>",
# "followers": {},
# "followup_ids": "<array>",
# "forum_topic_id": "<integer>",
# "from_messaging_channel": "<boolean>",
# "group_id": "<integer>",
# "has_incidents": "<boolean>",
# "id": "<integer>",
# "is_public": "<boolean>",
# "macro_id": "<integer>",
# "macro_ids": "<array>",
# "metadata": {},
# "organization_id": "<integer>",
# "priority": "urgent",
# "problem_id": "<integer>",
# "raw_subject": "<string>",
# "recipient": "<string>",
# "requester": {},
# "safe_update": "<boolean>",
# "satisfaction_rating": {
# "non9": 3831085,
# "eiusmod_3": 57077767.014250696
# },
# "sharing_agreement_ids": "<array>",
# "status": "solved",
# "subject": "<string>",
# "submitter_id": "<integer>",
# "tags": "<array>",
# "ticket_form_id": "<integer>",
# "type": "task",
# "updated_at": "<dateTime>",
# "updated_stamp": "<string>",
# "url": "<string>",
# "via": {
# "channel": "<string>",
# "source": {
# "in4": 87803065,
# "in57": "velit ipsum"
# }
# },
# "via_followup_source_id": "<integer>",
# "via_id": "<integer>",
# "voice_comment": {}
# },
# {
# "requester_id": "<integer>",
# "allow_attachments": "<boolean>",
# "allow_channelback": "<boolean>",
# "assignee_email": "<string>",
# "assignee_id": "<integer>",
# "attribute_value_ids": "<array>",
# "brand_id": "<integer>",
# "collaborator_ids": "<array>",
# "collaborators": [
# {
# "email": "<email>",
# "name": "<string>"
# },
# {
# "email": "<email>",
# "name": "<string>"
# }
# ],
# "comment": {},
# "created_at": "<dateTime>",
# "custom_fields": "<array>",
# "custom_status_id": "<integer>",
# "description": "<string>",
# "due_at": "<dateTime>",
# "email_cc_ids": "<array>",
# "email_ccs": {},
# "external_id": "<string>",
# "follower_ids": "<array>",
# "followers": {},
# "followup_ids": "<array>",
# "forum_topic_id": "<integer>",
# "from_messaging_channel": "<boolean>",
# "group_id": "<integer>",
# "has_incidents": "<boolean>",
# "id": "<integer>",
# "is_public": "<boolean>",
# "macro_id": "<integer>",
# "macro_ids": "<array>",
# "metadata": {},
# "organization_id": "<integer>",
# "priority": "low",
# "problem_id": "<integer>",
# "raw_subject": "<string>",
# "recipient": "<string>",
# "requester": {},
# "safe_update": "<boolean>",
# "satisfaction_rating": {
# "id_b": "qui dolore"
# },
# "sharing_agreement_ids": "<array>",
# "status": "pending",
# "subject": "<string>",
# "submitter_id": "<integer>",
# "tags": "<array>",
# "ticket_form_id": "<integer>",
# "type": "question",
# "updated_at": "<dateTime>",
# "updated_stamp": "<string>",
# "url": "<string>",
# "via": {
# "channel": "<string>",
# "source": {
# "ea___9": -17544125
# }
# },
# "via_followup_source_id": "<integer>",
# "via_id": "<integer>",
# "voice_comment": {}
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set after_cursor [CkJsonObject_stringOf $jResp "after_cursor"]
set after_url [CkJsonObject_stringOf $jResp "after_url"]
set before_cursor [CkJsonObject_stringOf $jResp "before_cursor"]
set before_url [CkJsonObject_stringOf $jResp "before_url"]
set end_of_stream [CkJsonObject_stringOf $jResp "end_of_stream"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "tickets"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set requester_id [CkJsonObject_stringOf $jResp "tickets[i].requester_id"]
set allow_attachments [CkJsonObject_stringOf $jResp "tickets[i].allow_attachments"]
set allow_channelback [CkJsonObject_stringOf $jResp "tickets[i].allow_channelback"]
set assignee_email [CkJsonObject_stringOf $jResp "tickets[i].assignee_email"]
set assignee_id [CkJsonObject_stringOf $jResp "tickets[i].assignee_id"]
set attribute_value_ids [CkJsonObject_stringOf $jResp "tickets[i].attribute_value_ids"]
set brand_id [CkJsonObject_stringOf $jResp "tickets[i].brand_id"]
set collaborator_ids [CkJsonObject_stringOf $jResp "tickets[i].collaborator_ids"]
set created_at [CkJsonObject_stringOf $jResp "tickets[i].created_at"]
set custom_fields [CkJsonObject_stringOf $jResp "tickets[i].custom_fields"]
set custom_status_id [CkJsonObject_stringOf $jResp "tickets[i].custom_status_id"]
set description [CkJsonObject_stringOf $jResp "tickets[i].description"]
set due_at [CkJsonObject_stringOf $jResp "tickets[i].due_at"]
set email_cc_ids [CkJsonObject_stringOf $jResp "tickets[i].email_cc_ids"]
set external_id [CkJsonObject_stringOf $jResp "tickets[i].external_id"]
set follower_ids [CkJsonObject_stringOf $jResp "tickets[i].follower_ids"]
set followup_ids [CkJsonObject_stringOf $jResp "tickets[i].followup_ids"]
set forum_topic_id [CkJsonObject_stringOf $jResp "tickets[i].forum_topic_id"]
set from_messaging_channel [CkJsonObject_stringOf $jResp "tickets[i].from_messaging_channel"]
set group_id [CkJsonObject_stringOf $jResp "tickets[i].group_id"]
set has_incidents [CkJsonObject_stringOf $jResp "tickets[i].has_incidents"]
set id [CkJsonObject_stringOf $jResp "tickets[i].id"]
set is_public [CkJsonObject_stringOf $jResp "tickets[i].is_public"]
set macro_id [CkJsonObject_stringOf $jResp "tickets[i].macro_id"]
set macro_ids [CkJsonObject_stringOf $jResp "tickets[i].macro_ids"]
set organization_id [CkJsonObject_stringOf $jResp "tickets[i].organization_id"]
set priority [CkJsonObject_stringOf $jResp "tickets[i].priority"]
set problem_id [CkJsonObject_stringOf $jResp "tickets[i].problem_id"]
set raw_subject [CkJsonObject_stringOf $jResp "tickets[i].raw_subject"]
set recipient [CkJsonObject_stringOf $jResp "tickets[i].recipient"]
set safe_update [CkJsonObject_stringOf $jResp "tickets[i].safe_update"]
set Non9 [CkJsonObject_IntOf $jResp "tickets[i].satisfaction_rating.non9"]
set Eiusmod_3 [CkJsonObject_stringOf $jResp "tickets[i].satisfaction_rating.eiusmod_3"]
set sharing_agreement_ids [CkJsonObject_stringOf $jResp "tickets[i].sharing_agreement_ids"]
set status [CkJsonObject_stringOf $jResp "tickets[i].status"]
set subject [CkJsonObject_stringOf $jResp "tickets[i].subject"]
set submitter_id [CkJsonObject_stringOf $jResp "tickets[i].submitter_id"]
set tags [CkJsonObject_stringOf $jResp "tickets[i].tags"]
set ticket_form_id [CkJsonObject_stringOf $jResp "tickets[i].ticket_form_id"]
set v_type [CkJsonObject_stringOf $jResp "tickets[i].type"]
set updated_at [CkJsonObject_stringOf $jResp "tickets[i].updated_at"]
set updated_stamp [CkJsonObject_stringOf $jResp "tickets[i].updated_stamp"]
set url [CkJsonObject_stringOf $jResp "tickets[i].url"]
set Channel [CkJsonObject_stringOf $jResp "tickets[i].via.channel"]
set In4 [CkJsonObject_IntOf $jResp "tickets[i].via.source.in4"]
set In57 [CkJsonObject_stringOf $jResp "tickets[i].via.source.in57"]
set via_followup_source_id [CkJsonObject_stringOf $jResp "tickets[i].via_followup_source_id"]
set via_id [CkJsonObject_stringOf $jResp "tickets[i].via_id"]
set Id_b [CkJsonObject_stringOf $jResp "tickets[i].satisfaction_rating.id_b"]
set Ea___9 [CkJsonObject_IntOf $jResp "tickets[i].via.source.ea___9"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "tickets[i].collaborators"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set email [CkJsonObject_stringOf $jResp "tickets[i].collaborators[j].email"]
set name [CkJsonObject_stringOf $jResp "tickets[i].collaborators[j].name"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -G -d "start_time=%3Cinteger%3E"
-d "cursor=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/tickets/cursor
Postman Collection Item JSON
{
"name": "Incremental Ticket Export, Cursor Based",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/incremental/tickets/cursor?start_time=<integer>&cursor=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
"tickets",
"cursor"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
},
{
"key": "cursor",
"value": "<string>",
"description": "The cursor pointer to work with for all subsequent exports after the initial request"
}
]
},
"description": "Returns the tickets that changed since the start time. For more information,\nsee [Exporting tickets](/documentation/ticketing/managing-tickets/using-the-incremental-export-api#exporting-tickets) in [Using the Incremental Exports API](/documentation/ticketing/managing-tickets/using-the-incremental-export-api).\n\nThis endpoint supports cursor-based incremental exports.\nCursor-based exports are highly encouraged because they provide more consistent performance and\nresponse body sizes. For more information, see [Cursor-based incremental exports](/documentation/ticketing/managing-tickets/using-the-incremental-export-api#cursor-based-incremental-exports) in [Using the Incremental Exports API](/documentation/ticketing/managing-tickets/using-the-incremental-export-api).\n\n\n\n#### Allowed For\n\n * Admins\n\n#### Sideloading\n\nSee [Tickets sideloads](/documentation/ticketing/using-the-zendesk-api/side_loading/#supported-endpoints). For performance reasons,\n`last_audits` sideloads aren't supported.\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/incremental/tickets/cursor?start_time=<integer>&cursor=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
"tickets",
"cursor"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
},
{
"key": "cursor",
"value": "<string>",
"description": "The cursor pointer to work with for all subsequent exports after the initial request"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"after_cursor\": \"<string>\",\n \"after_url\": \"<string>\",\n \"before_cursor\": \"<string>\",\n \"before_url\": \"<string>\",\n \"end_of_stream\": \"<boolean>\",\n \"tickets\": [\n {\n \"requester_id\": \"<integer>\",\n \"allow_attachments\": \"<boolean>\",\n \"allow_channelback\": \"<boolean>\",\n \"assignee_email\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"attribute_value_ids\": \"<array>\",\n \"brand_id\": \"<integer>\",\n \"collaborator_ids\": \"<array>\",\n \"collaborators\": [\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"comment\": {},\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": \"<array>\",\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": \"<array>\",\n \"email_ccs\": {},\n \"external_id\": \"<string>\",\n \"follower_ids\": \"<array>\",\n \"followers\": {},\n \"followup_ids\": \"<array>\",\n \"forum_topic_id\": \"<integer>\",\n \"from_messaging_channel\": \"<boolean>\",\n \"group_id\": \"<integer>\",\n \"has_incidents\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"macro_id\": \"<integer>\",\n \"macro_ids\": \"<array>\",\n \"metadata\": {},\n \"organization_id\": \"<integer>\",\n \"priority\": \"urgent\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"non9\": 3831085,\n \"eiusmod_3\": 57077767.014250696\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"solved\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"task\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"in4\": 87803065,\n \"in57\": \"velit ipsum\"\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n },\n {\n \"requester_id\": \"<integer>\",\n \"allow_attachments\": \"<boolean>\",\n \"allow_channelback\": \"<boolean>\",\n \"assignee_email\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"attribute_value_ids\": \"<array>\",\n \"brand_id\": \"<integer>\",\n \"collaborator_ids\": \"<array>\",\n \"collaborators\": [\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"comment\": {},\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": \"<array>\",\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": \"<array>\",\n \"email_ccs\": {},\n \"external_id\": \"<string>\",\n \"follower_ids\": \"<array>\",\n \"followers\": {},\n \"followup_ids\": \"<array>\",\n \"forum_topic_id\": \"<integer>\",\n \"from_messaging_channel\": \"<boolean>\",\n \"group_id\": \"<integer>\",\n \"has_incidents\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"macro_id\": \"<integer>\",\n \"macro_ids\": \"<array>\",\n \"metadata\": {},\n \"organization_id\": \"<integer>\",\n \"priority\": \"low\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"id_b\": \"qui dolore\"\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"pending\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"question\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"ea___9\": -17544125\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n }\n ]\n}"
}
]
}
