Swift3 / Support API / Incremental Ticket Event Export
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
http.basicAuth = true
http.login = "login"
http.password = "password"
let queryParams = CkoJsonObject()!
queryParams.update("start_time", value: "<integer>")
http.setRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://example.zendesk.com/api/v2/incremental/ticket_events", json: queryParams)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "count": "<integer>",
// "end_of_stream": "<boolean>",
// "end_time": "<integer>",
// "next_page": "<string>",
// "ticket_events": [
// {
// "id": "<integer>",
// "instance_id": "<integer>",
// "metric": "periodic_update_time",
// "ticket_id": "<integer>",
// "time": "<dateTime>",
// "type": "apply_sla"
// },
// {
// "id": "<integer>",
// "instance_id": "<integer>",
// "metric": "pausable_update_time",
// "ticket_id": "<integer>",
// "time": "<dateTime>",
// "type": "breach"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var id: String?
var instance_id: String?
var metric: String?
var ticket_id: String?
var time: String?
var v_type: String?
var count: String? = jResp.string(of: "count")
var end_of_stream: String? = jResp.string(of: "end_of_stream")
var end_time: String? = jResp.string(of: "end_time")
var next_page: String? = jResp.string(of: "next_page")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "ticket_events").intValue
while i < count_i {
jResp.i = i
id = jResp.string(of: "ticket_events[i].id")
instance_id = jResp.string(of: "ticket_events[i].instance_id")
metric = jResp.string(of: "ticket_events[i].metric")
ticket_id = jResp.string(of: "ticket_events[i].ticket_id")
time = jResp.string(of: "ticket_events[i].time")
v_type = jResp.string(of: "ticket_events[i].type")
i = i + 1
}
}
Curl Command
curl -u login:password -G -d "start_time=%3Cinteger%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/ticket_events
Postman Collection Item JSON
{
"name": "Incremental Ticket Event Export",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/incremental/ticket_events?start_time=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
"ticket_events"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
}
]
},
"description": "Returns a stream of changes that occurred on tickets. Each event is tied\nto an update on a ticket and contains all the fields that were updated in that\nchange. For more information, see:\n\n- [Exporting ticket events](/documentation/ticketing/managing-tickets/using-the-incremental-export-api#exporting-ticket-events) in [Using the Incremental Exports API](/documentation/ticketing/managing-tickets/using-the-incremental-export-api)\n- [Time-based incremental exports](/documentation/ticketing/managing-tickets/using-the-incremental-export-api#time-based-incremental-exports) in [Using the Incremental Exports API](/documentation/ticketing/managing-tickets/using-the-incremental-export-api)\n\nYou can include comments in the event stream by using the `comment_events`\nsideload. See Sideloading below. If you don't specify the sideload, any comment\npresent in the ticket update is described only by Boolean `comment_present`\nand `comment_public` object properties in the event's `child_events` array.\nThe comment itself is not included.\n\n#### Allowed For\n\n * Admins\n\n#### Sideloading\n\nThe endpoint supports the `comment_events` sideload. Any comment present in the ticket\nupdate is listed as an object in the event's `child_events` array. Example:\n\n```js\n\"child_events\": [\n {\n \"id\": 91048994488,\n \"via\": {\n \"channel\": \"api\",\n \"source\": {\"from\":{},\"to\":{},\"rel\":null}},\n \"via_reference_id\":null,\n \"type\": \"Comment\",\n \"author_id\": 5031726587,\n \"body\": \"This is a comment\",\n \"html_body\": \"<div class=\"zd-comment\"><p dir=\"auto\">This is a comment</p>\",\n \"public\": true,\n \"attachments\": [],\n \"audit_id\": 91048994468,\n \"created_at\": \"2009-06-25T10:15:18Z\",\n \"event_type\": \"Comment\"\n },\n ...\n],\n...\n```\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/ticket_events?start_time=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
"ticket_events"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"end_of_stream\": \"<boolean>\",\n \"end_time\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"ticket_events\": [\n {\n \"id\": \"<integer>\",\n \"instance_id\": \"<integer>\",\n \"metric\": \"periodic_update_time\",\n \"ticket_id\": \"<integer>\",\n \"time\": \"<dateTime>\",\n \"type\": \"apply_sla\"\n },\n {\n \"id\": \"<integer>\",\n \"instance_id\": \"<integer>\",\n \"metric\": \"pausable_update_time\",\n \"ticket_id\": \"<integer>\",\n \"time\": \"<dateTime>\",\n \"type\": \"breach\"\n }\n ]\n}"
}
]
}
