TCL / Support API / Show Ticket Metrics
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/ticket_metrics/:ticket_metric_id" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "ticket_metric"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set Business [CkJsonObject_stringOf $jResp "ticket_metric[i].agent_wait_time_in_minutes.business"]
set Calendar [CkJsonObject_stringOf $jResp "ticket_metric[i].agent_wait_time_in_minutes.calendar"]
set assigned_at [CkJsonObject_stringOf $jResp "ticket_metric[i].assigned_at"]
set assignee_stations [CkJsonObject_stringOf $jResp "ticket_metric[i].assignee_stations"]
set assignee_updated_at [CkJsonObject_stringOf $jResp "ticket_metric[i].assignee_updated_at"]
set created_at [CkJsonObject_stringOf $jResp "ticket_metric[i].created_at"]
set custom_status_updated_at [CkJsonObject_stringOf $jResp "ticket_metric[i].custom_status_updated_at"]
set first_resolution_time_in_minutesBusiness [CkJsonObject_stringOf $jResp "ticket_metric[i].first_resolution_time_in_minutes.business"]
set first_resolution_time_in_minutesCalendar [CkJsonObject_stringOf $jResp "ticket_metric[i].first_resolution_time_in_minutes.calendar"]
set full_resolution_time_in_minutesBusiness [CkJsonObject_stringOf $jResp "ticket_metric[i].full_resolution_time_in_minutes.business"]
set full_resolution_time_in_minutesCalendar [CkJsonObject_stringOf $jResp "ticket_metric[i].full_resolution_time_in_minutes.calendar"]
set group_stations [CkJsonObject_stringOf $jResp "ticket_metric[i].group_stations"]
set id [CkJsonObject_stringOf $jResp "ticket_metric[i].id"]
set initially_assigned_at [CkJsonObject_stringOf $jResp "ticket_metric[i].initially_assigned_at"]
set latest_comment_added_at [CkJsonObject_stringOf $jResp "ticket_metric[i].latest_comment_added_at"]
set on_hold_time_in_minutesBusiness [CkJsonObject_stringOf $jResp "ticket_metric[i].on_hold_time_in_minutes.business"]
set on_hold_time_in_minutesCalendar [CkJsonObject_stringOf $jResp "ticket_metric[i].on_hold_time_in_minutes.calendar"]
set reopens [CkJsonObject_stringOf $jResp "ticket_metric[i].reopens"]
set replies [CkJsonObject_stringOf $jResp "ticket_metric[i].replies"]
set reply_time_in_minutesBusiness [CkJsonObject_stringOf $jResp "ticket_metric[i].reply_time_in_minutes.business"]
set reply_time_in_minutesCalendar [CkJsonObject_stringOf $jResp "ticket_metric[i].reply_time_in_minutes.calendar"]
set reply_time_in_secondsBusiness [CkJsonObject_stringOf $jResp "ticket_metric[i].reply_time_in_seconds.business"]
set reply_time_in_secondsCalendar [CkJsonObject_stringOf $jResp "ticket_metric[i].reply_time_in_seconds.calendar"]
set requester_updated_at [CkJsonObject_stringOf $jResp "ticket_metric[i].requester_updated_at"]
set requester_wait_time_in_minutesBusiness [CkJsonObject_stringOf $jResp "ticket_metric[i].requester_wait_time_in_minutes.business"]
set requester_wait_time_in_minutesCalendar [CkJsonObject_stringOf $jResp "ticket_metric[i].requester_wait_time_in_minutes.calendar"]
set solved_at [CkJsonObject_stringOf $jResp "ticket_metric[i].solved_at"]
set status_updated_at [CkJsonObject_stringOf $jResp "ticket_metric[i].status_updated_at"]
set ticket_id [CkJsonObject_stringOf $jResp "ticket_metric[i].ticket_id"]
set updated_at [CkJsonObject_stringOf $jResp "ticket_metric[i].updated_at"]
set url [CkJsonObject_stringOf $jResp "ticket_metric[i].url"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
