Swift / Support API / Show Ticket Metrics
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"
http.SetRequestHeader("Accept", value: "application/json")
let sbResponseBody = CkoStringBuilder()
success = http.QuickGetSb("https://example.zendesk.com/api/v2/ticket_metrics/:ticket_metric_id", sbContent: sbResponseBody)
if success == false {
print("\(http.LastErrorText)")
return
}
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = http.LastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.LastHeader)")
print("Failed.")
return
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "ticket_metric": [
// {
// "agent_wait_time_in_minutes": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "assigned_at": "<dateTime>",
// "assignee_stations": "<integer>",
// "assignee_updated_at": "<dateTime>",
// "created_at": "<dateTime>",
// "custom_status_updated_at": "<dateTime>",
// "first_resolution_time_in_minutes": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "full_resolution_time_in_minutes": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "group_stations": "<integer>",
// "id": "<integer>",
// "initially_assigned_at": "<dateTime>",
// "latest_comment_added_at": "<dateTime>",
// "on_hold_time_in_minutes": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "reopens": "<integer>",
// "replies": "<integer>",
// "reply_time_in_minutes": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "reply_time_in_seconds": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "requester_updated_at": "<dateTime>",
// "requester_wait_time_in_minutes": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "solved_at": "<dateTime>",
// "status_updated_at": "<dateTime>",
// "ticket_id": "<integer>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "agent_wait_time_in_minutes": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "assigned_at": "<dateTime>",
// "assignee_stations": "<integer>",
// "assignee_updated_at": "<dateTime>",
// "created_at": "<dateTime>",
// "custom_status_updated_at": "<dateTime>",
// "first_resolution_time_in_minutes": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "full_resolution_time_in_minutes": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "group_stations": "<integer>",
// "id": "<integer>",
// "initially_assigned_at": "<dateTime>",
// "latest_comment_added_at": "<dateTime>",
// "on_hold_time_in_minutes": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "reopens": "<integer>",
// "replies": "<integer>",
// "reply_time_in_minutes": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "reply_time_in_seconds": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "requester_updated_at": "<dateTime>",
// "requester_wait_time_in_minutes": {
// "business": "<integer>",
// "calendar": "<integer>"
// },
// "solved_at": "<dateTime>",
// "status_updated_at": "<dateTime>",
// "ticket_id": "<integer>",
// "updated_at": "<dateTime>",
// "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 Business: String?
var Calendar: String?
var assigned_at: String?
var assignee_stations: String?
var assignee_updated_at: String?
var created_at: String?
var custom_status_updated_at: String?
var first_resolution_time_in_minutesBusiness: String?
var first_resolution_time_in_minutesCalendar: String?
var full_resolution_time_in_minutesBusiness: String?
var full_resolution_time_in_minutesCalendar: String?
var group_stations: String?
var id: String?
var initially_assigned_at: String?
var latest_comment_added_at: String?
var on_hold_time_in_minutesBusiness: String?
var on_hold_time_in_minutesCalendar: String?
var reopens: String?
var replies: String?
var reply_time_in_minutesBusiness: String?
var reply_time_in_minutesCalendar: String?
var reply_time_in_secondsBusiness: String?
var reply_time_in_secondsCalendar: String?
var requester_updated_at: String?
var requester_wait_time_in_minutesBusiness: String?
var requester_wait_time_in_minutesCalendar: String?
var solved_at: String?
var status_updated_at: String?
var ticket_id: String?
var updated_at: String?
var url: String?
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("ticket_metric").intValue
while i < count_i {
jResp.I = i
Business = jResp.StringOf("ticket_metric[i].agent_wait_time_in_minutes.business")
Calendar = jResp.StringOf("ticket_metric[i].agent_wait_time_in_minutes.calendar")
assigned_at = jResp.StringOf("ticket_metric[i].assigned_at")
assignee_stations = jResp.StringOf("ticket_metric[i].assignee_stations")
assignee_updated_at = jResp.StringOf("ticket_metric[i].assignee_updated_at")
created_at = jResp.StringOf("ticket_metric[i].created_at")
custom_status_updated_at = jResp.StringOf("ticket_metric[i].custom_status_updated_at")
first_resolution_time_in_minutesBusiness = jResp.StringOf("ticket_metric[i].first_resolution_time_in_minutes.business")
first_resolution_time_in_minutesCalendar = jResp.StringOf("ticket_metric[i].first_resolution_time_in_minutes.calendar")
full_resolution_time_in_minutesBusiness = jResp.StringOf("ticket_metric[i].full_resolution_time_in_minutes.business")
full_resolution_time_in_minutesCalendar = jResp.StringOf("ticket_metric[i].full_resolution_time_in_minutes.calendar")
group_stations = jResp.StringOf("ticket_metric[i].group_stations")
id = jResp.StringOf("ticket_metric[i].id")
initially_assigned_at = jResp.StringOf("ticket_metric[i].initially_assigned_at")
latest_comment_added_at = jResp.StringOf("ticket_metric[i].latest_comment_added_at")
on_hold_time_in_minutesBusiness = jResp.StringOf("ticket_metric[i].on_hold_time_in_minutes.business")
on_hold_time_in_minutesCalendar = jResp.StringOf("ticket_metric[i].on_hold_time_in_minutes.calendar")
reopens = jResp.StringOf("ticket_metric[i].reopens")
replies = jResp.StringOf("ticket_metric[i].replies")
reply_time_in_minutesBusiness = jResp.StringOf("ticket_metric[i].reply_time_in_minutes.business")
reply_time_in_minutesCalendar = jResp.StringOf("ticket_metric[i].reply_time_in_minutes.calendar")
reply_time_in_secondsBusiness = jResp.StringOf("ticket_metric[i].reply_time_in_seconds.business")
reply_time_in_secondsCalendar = jResp.StringOf("ticket_metric[i].reply_time_in_seconds.calendar")
requester_updated_at = jResp.StringOf("ticket_metric[i].requester_updated_at")
requester_wait_time_in_minutesBusiness = jResp.StringOf("ticket_metric[i].requester_wait_time_in_minutes.business")
requester_wait_time_in_minutesCalendar = jResp.StringOf("ticket_metric[i].requester_wait_time_in_minutes.calendar")
solved_at = jResp.StringOf("ticket_metric[i].solved_at")
status_updated_at = jResp.StringOf("ticket_metric[i].status_updated_at")
ticket_id = jResp.StringOf("ticket_metric[i].ticket_id")
updated_at = jResp.StringOf("ticket_metric[i].updated_at")
url = jResp.StringOf("ticket_metric[i].url")
i = i + 1
}
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_metrics/:ticket_metric_id
Postman Collection Item JSON
{
"name": "Show Ticket Metrics",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ticket_metrics/:ticket_metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_metrics",
":ticket_metric_id"
],
"variable": [
{
"key": "ticket_metric_id",
"value": "<string>"
}
]
},
"description": "Returns a specific metric, or the metrics of a specific ticket.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Agents\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_metrics/:ticket_metric_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_metrics",
":ticket_metric_id"
],
"variable": [
{
"key": "ticket_metric_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"ticket_metric\": [\n {\n \"agent_wait_time_in_minutes\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"assigned_at\": \"<dateTime>\",\n \"assignee_stations\": \"<integer>\",\n \"assignee_updated_at\": \"<dateTime>\",\n \"created_at\": \"<dateTime>\",\n \"custom_status_updated_at\": \"<dateTime>\",\n \"first_resolution_time_in_minutes\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"full_resolution_time_in_minutes\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"group_stations\": \"<integer>\",\n \"id\": \"<integer>\",\n \"initially_assigned_at\": \"<dateTime>\",\n \"latest_comment_added_at\": \"<dateTime>\",\n \"on_hold_time_in_minutes\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"reopens\": \"<integer>\",\n \"replies\": \"<integer>\",\n \"reply_time_in_minutes\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"reply_time_in_seconds\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"requester_updated_at\": \"<dateTime>\",\n \"requester_wait_time_in_minutes\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"solved_at\": \"<dateTime>\",\n \"status_updated_at\": \"<dateTime>\",\n \"ticket_id\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"agent_wait_time_in_minutes\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"assigned_at\": \"<dateTime>\",\n \"assignee_stations\": \"<integer>\",\n \"assignee_updated_at\": \"<dateTime>\",\n \"created_at\": \"<dateTime>\",\n \"custom_status_updated_at\": \"<dateTime>\",\n \"first_resolution_time_in_minutes\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"full_resolution_time_in_minutes\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"group_stations\": \"<integer>\",\n \"id\": \"<integer>\",\n \"initially_assigned_at\": \"<dateTime>\",\n \"latest_comment_added_at\": \"<dateTime>\",\n \"on_hold_time_in_minutes\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"reopens\": \"<integer>\",\n \"replies\": \"<integer>\",\n \"reply_time_in_minutes\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"reply_time_in_seconds\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"requester_updated_at\": \"<dateTime>\",\n \"requester_wait_time_in_minutes\": {\n \"business\": \"<integer>\",\n \"calendar\": \"<integer>\"\n },\n \"solved_at\": \"<dateTime>\",\n \"status_updated_at\": \"<dateTime>\",\n \"ticket_id\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
