Foxpro / Support API / Incremental Ticket Export, Cursor Based
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcRequester_id
LOCAL lcAllow_attachments
LOCAL lcAllow_channelback
LOCAL lcAssignee_email
LOCAL lcAssignee_id
LOCAL lcAttribute_value_ids
LOCAL lcBrand_id
LOCAL lcCollaborator_ids
LOCAL lcCreated_at
LOCAL lcCustom_fields
LOCAL lcCustom_status_id
LOCAL lcDescription
LOCAL lcDue_at
LOCAL lcEmail_cc_ids
LOCAL lcExternal_id
LOCAL lcFollower_ids
LOCAL lcFollowup_ids
LOCAL lcForum_topic_id
LOCAL lcFrom_messaging_channel
LOCAL lcGroup_id
LOCAL lcHas_incidents
LOCAL lcId
LOCAL lcIs_public
LOCAL lcMacro_id
LOCAL lcMacro_ids
LOCAL lcOrganization_id
LOCAL lcPriority
LOCAL lcProblem_id
LOCAL lcRaw_subject
LOCAL lcRecipient
LOCAL lcSafe_update
LOCAL lnNon9
LOCAL lcEiusmod_3
LOCAL lcSharing_agreement_ids
LOCAL lcStatus
LOCAL lcSubject
LOCAL lcSubmitter_id
LOCAL lcTags
LOCAL lcTicket_form_id
LOCAL lcV_type
LOCAL lcUpdated_at
LOCAL lcUpdated_stamp
LOCAL lcUrl
LOCAL lcChannel
LOCAL lnIn4
LOCAL lcIn57
LOCAL lcVia_followup_source_id
LOCAL lcVia_id
LOCAL lcId_b
LOCAL lnEa___9
LOCAL j
LOCAL lnCount_j
LOCAL lcEmail
LOCAL lcName
LOCAL lcAfter_cursor
LOCAL lcAfter_url
LOCAL lcBefore_cursor
LOCAL lcBefore_url
LOCAL lcEnd_of_stream
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("start_time","<integer>")
loQueryParams.UpdateString("cursor","<string>")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/tickets/cursor",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcAfter_cursor = loJResp.StringOf("after_cursor")
lcAfter_url = loJResp.StringOf("after_url")
lcBefore_cursor = loJResp.StringOf("before_cursor")
lcBefore_url = loJResp.StringOf("before_url")
lcEnd_of_stream = loJResp.StringOf("end_of_stream")
i = 0
lnCount_i = loJResp.SizeOfArray("tickets")
DO WHILE i < lnCount_i
loJResp.I = i
lcRequester_id = loJResp.StringOf("tickets[i].requester_id")
lcAllow_attachments = loJResp.StringOf("tickets[i].allow_attachments")
lcAllow_channelback = loJResp.StringOf("tickets[i].allow_channelback")
lcAssignee_email = loJResp.StringOf("tickets[i].assignee_email")
lcAssignee_id = loJResp.StringOf("tickets[i].assignee_id")
lcAttribute_value_ids = loJResp.StringOf("tickets[i].attribute_value_ids")
lcBrand_id = loJResp.StringOf("tickets[i].brand_id")
lcCollaborator_ids = loJResp.StringOf("tickets[i].collaborator_ids")
lcCreated_at = loJResp.StringOf("tickets[i].created_at")
lcCustom_fields = loJResp.StringOf("tickets[i].custom_fields")
lcCustom_status_id = loJResp.StringOf("tickets[i].custom_status_id")
lcDescription = loJResp.StringOf("tickets[i].description")
lcDue_at = loJResp.StringOf("tickets[i].due_at")
lcEmail_cc_ids = loJResp.StringOf("tickets[i].email_cc_ids")
lcExternal_id = loJResp.StringOf("tickets[i].external_id")
lcFollower_ids = loJResp.StringOf("tickets[i].follower_ids")
lcFollowup_ids = loJResp.StringOf("tickets[i].followup_ids")
lcForum_topic_id = loJResp.StringOf("tickets[i].forum_topic_id")
lcFrom_messaging_channel = loJResp.StringOf("tickets[i].from_messaging_channel")
lcGroup_id = loJResp.StringOf("tickets[i].group_id")
lcHas_incidents = loJResp.StringOf("tickets[i].has_incidents")
lcId = loJResp.StringOf("tickets[i].id")
lcIs_public = loJResp.StringOf("tickets[i].is_public")
lcMacro_id = loJResp.StringOf("tickets[i].macro_id")
lcMacro_ids = loJResp.StringOf("tickets[i].macro_ids")
lcOrganization_id = loJResp.StringOf("tickets[i].organization_id")
lcPriority = loJResp.StringOf("tickets[i].priority")
lcProblem_id = loJResp.StringOf("tickets[i].problem_id")
lcRaw_subject = loJResp.StringOf("tickets[i].raw_subject")
lcRecipient = loJResp.StringOf("tickets[i].recipient")
lcSafe_update = loJResp.StringOf("tickets[i].safe_update")
lnNon9 = loJResp.IntOf("tickets[i].satisfaction_rating.non9")
lcEiusmod_3 = loJResp.StringOf("tickets[i].satisfaction_rating.eiusmod_3")
lcSharing_agreement_ids = loJResp.StringOf("tickets[i].sharing_agreement_ids")
lcStatus = loJResp.StringOf("tickets[i].status")
lcSubject = loJResp.StringOf("tickets[i].subject")
lcSubmitter_id = loJResp.StringOf("tickets[i].submitter_id")
lcTags = loJResp.StringOf("tickets[i].tags")
lcTicket_form_id = loJResp.StringOf("tickets[i].ticket_form_id")
lcV_type = loJResp.StringOf("tickets[i].type")
lcUpdated_at = loJResp.StringOf("tickets[i].updated_at")
lcUpdated_stamp = loJResp.StringOf("tickets[i].updated_stamp")
lcUrl = loJResp.StringOf("tickets[i].url")
lcChannel = loJResp.StringOf("tickets[i].via.channel")
lnIn4 = loJResp.IntOf("tickets[i].via.source.in4")
lcIn57 = loJResp.StringOf("tickets[i].via.source.in57")
lcVia_followup_source_id = loJResp.StringOf("tickets[i].via_followup_source_id")
lcVia_id = loJResp.StringOf("tickets[i].via_id")
lcId_b = loJResp.StringOf("tickets[i].satisfaction_rating.id_b")
lnEa___9 = loJResp.IntOf("tickets[i].via.source.ea___9")
j = 0
lnCount_j = loJResp.SizeOfArray("tickets[i].collaborators")
DO WHILE j < lnCount_j
loJResp.J = j
lcEmail = loJResp.StringOf("tickets[i].collaborators[j].email")
lcName = loJResp.StringOf("tickets[i].collaborators[j].name")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
