VBScript / Support API / Incremental Ticket Export, Cursor Based
Back to Collection Items
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")
http.BasicAuth = 1
http.Login = "login"
http.Password = "password"
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set queryParams = CreateObject("Chilkat.JsonObject")
success = queryParams.UpdateString("start_time","<integer>")
success = queryParams.UpdateString("cursor","<string>")
http.SetRequestHeader "Accept","application/json"
' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/tickets/cursor",queryParams)
If (http.LastMethodSuccess = 0) Then
outFile.WriteLine(http.LastErrorText)
WScript.Quit
End If
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())
respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
outFile.WriteLine("Response Header:")
outFile.WriteLine(resp.Header)
outFile.WriteLine("Failed.")
WScript.Quit
End If
' 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
after_cursor = jResp.StringOf("after_cursor")
after_url = jResp.StringOf("after_url")
before_cursor = jResp.StringOf("before_cursor")
before_url = jResp.StringOf("before_url")
end_of_stream = jResp.StringOf("end_of_stream")
i = 0
count_i = jResp.SizeOfArray("tickets")
Do While i < count_i
jResp.I = i
requester_id = jResp.StringOf("tickets[i].requester_id")
allow_attachments = jResp.StringOf("tickets[i].allow_attachments")
allow_channelback = jResp.StringOf("tickets[i].allow_channelback")
assignee_email = jResp.StringOf("tickets[i].assignee_email")
assignee_id = jResp.StringOf("tickets[i].assignee_id")
attribute_value_ids = jResp.StringOf("tickets[i].attribute_value_ids")
brand_id = jResp.StringOf("tickets[i].brand_id")
collaborator_ids = jResp.StringOf("tickets[i].collaborator_ids")
created_at = jResp.StringOf("tickets[i].created_at")
custom_fields = jResp.StringOf("tickets[i].custom_fields")
custom_status_id = jResp.StringOf("tickets[i].custom_status_id")
description = jResp.StringOf("tickets[i].description")
due_at = jResp.StringOf("tickets[i].due_at")
email_cc_ids = jResp.StringOf("tickets[i].email_cc_ids")
external_id = jResp.StringOf("tickets[i].external_id")
follower_ids = jResp.StringOf("tickets[i].follower_ids")
followup_ids = jResp.StringOf("tickets[i].followup_ids")
forum_topic_id = jResp.StringOf("tickets[i].forum_topic_id")
from_messaging_channel = jResp.StringOf("tickets[i].from_messaging_channel")
group_id = jResp.StringOf("tickets[i].group_id")
has_incidents = jResp.StringOf("tickets[i].has_incidents")
id = jResp.StringOf("tickets[i].id")
is_public = jResp.StringOf("tickets[i].is_public")
macro_id = jResp.StringOf("tickets[i].macro_id")
macro_ids = jResp.StringOf("tickets[i].macro_ids")
organization_id = jResp.StringOf("tickets[i].organization_id")
priority = jResp.StringOf("tickets[i].priority")
problem_id = jResp.StringOf("tickets[i].problem_id")
raw_subject = jResp.StringOf("tickets[i].raw_subject")
recipient = jResp.StringOf("tickets[i].recipient")
safe_update = jResp.StringOf("tickets[i].safe_update")
Non9 = jResp.IntOf("tickets[i].satisfaction_rating.non9")
Eiusmod_3 = jResp.StringOf("tickets[i].satisfaction_rating.eiusmod_3")
sharing_agreement_ids = jResp.StringOf("tickets[i].sharing_agreement_ids")
status = jResp.StringOf("tickets[i].status")
subject = jResp.StringOf("tickets[i].subject")
submitter_id = jResp.StringOf("tickets[i].submitter_id")
tags = jResp.StringOf("tickets[i].tags")
ticket_form_id = jResp.StringOf("tickets[i].ticket_form_id")
v_type = jResp.StringOf("tickets[i].type")
updated_at = jResp.StringOf("tickets[i].updated_at")
updated_stamp = jResp.StringOf("tickets[i].updated_stamp")
url = jResp.StringOf("tickets[i].url")
Channel = jResp.StringOf("tickets[i].via.channel")
In4 = jResp.IntOf("tickets[i].via.source.in4")
In57 = jResp.StringOf("tickets[i].via.source.in57")
via_followup_source_id = jResp.StringOf("tickets[i].via_followup_source_id")
via_id = jResp.StringOf("tickets[i].via_id")
Id_b = jResp.StringOf("tickets[i].satisfaction_rating.id_b")
Ea___9 = jResp.IntOf("tickets[i].via.source.ea___9")
j = 0
count_j = jResp.SizeOfArray("tickets[i].collaborators")
Do While j < count_j
jResp.J = j
email = jResp.StringOf("tickets[i].collaborators[j].email")
name = jResp.StringOf("tickets[i].collaborators[j].name")
j = j + 1
Loop
i = i + 1
Loop
outFile.Close
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}"
}
]
}
