Chilkat Online Tools

Swift / Support API / List All Ticket Audits

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.UpdateString("limit", value: "<integer>")

    http.SetRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://example.zendesk.com/api/v2/ticket_audits", 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)

    // {
    //   "after_cursor": "<string>",
    //   "after_url": "<string>",
    //   "audits": [
    //     {
    //       "author_id": "<integer>",
    //       "created_at": "<dateTime>",
    //       "events": [
    //         {
    //           "voluptate_edf": 37194901.82832828,
    //           "dolor0": 61753613
    //         },
    //         {
    //           "sedb2": false
    //         }
    //       ],
    //       "id": "<integer>",
    //       "metadata": {
    //         "aute__": "proident aute qui culpa",
    //         "ex_ae": "dolore Lorem labore ut"
    //       },
    //       "ticket_id": "<integer>",
    //       "via": {
    //         "channel": "<string>",
    //         "source": {
    //           "et_c59": 68912889
    //         }
    //       }
    //     },
    //     {
    //       "author_id": "<integer>",
    //       "created_at": "<dateTime>",
    //       "events": [
    //         {
    //           "nostrud_fd6": -68241256.05178377
    //         },
    //         {
    //           "ullamcoe": "ad",
    //           "adipisicing_1": false
    //         }
    //       ],
    //       "id": "<integer>",
    //       "metadata": {
    //         "veniam_689": -18333948.100650415,
    //         "elit_2ab": "eu dolor deserunt consequat dolore"
    //       },
    //       "ticket_id": "<integer>",
    //       "via": {
    //         "channel": "<string>",
    //         "source": {
    //           "sint490": -68016605.99205834
    //         }
    //       }
    //     }
    //   ],
    //   "before_cursor": "<string>",
    //   "before_url": "<string>"
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var author_id: String?
    var created_at: String?
    var id: String?
    var Aute__: String?
    var Ex_ae: String?
    var ticket_id: String?
    var Channel: String?
    var Et_c59: Int
    var Veniam_689: String?
    var Elit_2ab: String?
    var Sint490: String?
    var j: Int
    var count_j: Int
    var voluptate_edf: String?
    var dolor0: Int
    var sedb2: Bool
    var nostrud_fd6: String?
    var ullamcoe: String?
    var adipisicing_1: Bool

    var after_cursor: String? = jResp.StringOf("after_cursor")
    var after_url: String? = jResp.StringOf("after_url")
    var before_cursor: String? = jResp.StringOf("before_cursor")
    var before_url: String? = jResp.StringOf("before_url")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("audits").intValue
    while i < count_i {
        jResp.I = i
        author_id = jResp.StringOf("audits[i].author_id")
        created_at = jResp.StringOf("audits[i].created_at")
        id = jResp.StringOf("audits[i].id")
        Aute__ = jResp.StringOf("audits[i].metadata.aute__")
        Ex_ae = jResp.StringOf("audits[i].metadata.ex_ae")
        ticket_id = jResp.StringOf("audits[i].ticket_id")
        Channel = jResp.StringOf("audits[i].via.channel")
        Et_c59 = jResp.IntOf("audits[i].via.source.et_c59").intValue
        Veniam_689 = jResp.StringOf("audits[i].metadata.veniam_689")
        Elit_2ab = jResp.StringOf("audits[i].metadata.elit_2ab")
        Sint490 = jResp.StringOf("audits[i].via.source.sint490")
        j = 0
        count_j = jResp.SizeOfArray("audits[i].events").intValue
        while j < count_j {
            jResp.J = j
            voluptate_edf = jResp.StringOf("audits[i].events[j].voluptate_edf")
            dolor0 = jResp.IntOf("audits[i].events[j].dolor0").intValue
            sedb2 = jResp.BoolOf("audits[i].events[j].sedb2")
            nostrud_fd6 = jResp.StringOf("audits[i].events[j].nostrud_fd6")
            ullamcoe = jResp.StringOf("audits[i].events[j].ullamcoe")
            adipisicing_1 = jResp.BoolOf("audits[i].events[j].adipisicing_1")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl  -u login:password -G -d "limit=%3Cinteger%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_audits

Postman Collection Item JSON

{
  "name": "List All Ticket Audits",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/ticket_audits?limit=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "ticket_audits"
      ],
      "query": [
        {
          "key": "limit",
          "value": "<integer>",
          "description": "Maximum number of results returned"
        }
      ]
    },
    "description": "Returns ticket audits. Archived tickets are not included in the response. Use the [List Audits for a Ticket](#list-audits-for-a-ticket) endpoint to \nretrieve audit records for an archived ticket. To learn more about archived tickets, see [About archived tickets](https://support.zendesk.com/hc/en-us/articles/203657756).\n\nThis endpoint should not be used for capturing change data. When continually chasing the tail of a cursor, some records will be skipped. For this use case, use the [Incremental Ticket Event Export API](/api-reference/ticketing/ticket-management/incremental_exports/#incremental-ticket-event-export).\n\n#### Pagination\n\n- Cursor pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Admins\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/ticket_audits?limit=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ticket_audits"
          ],
          "query": [
            {
              "key": "limit",
              "value": "<integer>",
              "description": "Maximum number of results returned"
            }
          ]
        }
      },
      "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  \"audits\": [\n    {\n      \"author_id\": \"<integer>\",\n      \"created_at\": \"<dateTime>\",\n      \"events\": [\n        {\n          \"voluptate_edf\": 37194901.82832828,\n          \"dolor0\": 61753613\n        },\n        {\n          \"sedb2\": false\n        }\n      ],\n      \"id\": \"<integer>\",\n      \"metadata\": {\n        \"aute__\": \"proident aute qui culpa\",\n        \"ex_ae\": \"dolore Lorem labore ut\"\n      },\n      \"ticket_id\": \"<integer>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"et_c59\": 68912889\n        }\n      }\n    },\n    {\n      \"author_id\": \"<integer>\",\n      \"created_at\": \"<dateTime>\",\n      \"events\": [\n        {\n          \"nostrud_fd6\": -68241256.05178377\n        },\n        {\n          \"ullamcoe\": \"ad\",\n          \"adipisicing_1\": false\n        }\n      ],\n      \"id\": \"<integer>\",\n      \"metadata\": {\n        \"veniam_689\": -18333948.100650415,\n        \"elit_2ab\": \"eu dolor deserunt consequat dolore\"\n      },\n      \"ticket_id\": \"<integer>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"sint490\": -68016605.99205834\n        }\n      }\n    }\n  ],\n  \"before_cursor\": \"<string>\",\n  \"before_url\": \"<string>\"\n}"
    }
  ]
}