PowerBuilder / Support API / List Ticket Metrics
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Business
string ls_Calendar
string ls_Assigned_at
string ls_Assignee_stations
string ls_Assignee_updated_at
string ls_Created_at
string ls_Custom_status_updated_at
string ls_First_resolution_time_in_minutesBusiness
string ls_First_resolution_time_in_minutesCalendar
string ls_Full_resolution_time_in_minutesBusiness
string ls_Full_resolution_time_in_minutesCalendar
string ls_Group_stations
string ls_Id
string ls_Initially_assigned_at
string ls_Latest_comment_added_at
string ls_On_hold_time_in_minutesBusiness
string ls_On_hold_time_in_minutesCalendar
string ls_Reopens
string ls_Replies
string ls_Reply_time_in_minutesBusiness
string ls_Reply_time_in_minutesCalendar
string ls_Reply_time_in_secondsBusiness
string ls_Reply_time_in_secondsCalendar
string ls_Requester_updated_at
string ls_Requester_wait_time_in_minutesBusiness
string ls_Requester_wait_time_in_minutesCalendar
string ls_Solved_at
string ls_Status_updated_at
string ls_Ticket_id
string ls_Updated_at
string ls_Url
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_Http.SetRequestHeader("Accept","application/json")
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://example.zendesk.com/api/v2/ticket_metrics",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "ticket_metrics": [
// {
// "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
i = 0
li_Count_i = loo_JResp.SizeOfArray("ticket_metrics")
do while i < li_Count_i
loo_JResp.I = i
ls_Business = loo_JResp.StringOf("ticket_metrics[i].agent_wait_time_in_minutes.business")
ls_Calendar = loo_JResp.StringOf("ticket_metrics[i].agent_wait_time_in_minutes.calendar")
ls_Assigned_at = loo_JResp.StringOf("ticket_metrics[i].assigned_at")
ls_Assignee_stations = loo_JResp.StringOf("ticket_metrics[i].assignee_stations")
ls_Assignee_updated_at = loo_JResp.StringOf("ticket_metrics[i].assignee_updated_at")
ls_Created_at = loo_JResp.StringOf("ticket_metrics[i].created_at")
ls_Custom_status_updated_at = loo_JResp.StringOf("ticket_metrics[i].custom_status_updated_at")
ls_First_resolution_time_in_minutesBusiness = loo_JResp.StringOf("ticket_metrics[i].first_resolution_time_in_minutes.business")
ls_First_resolution_time_in_minutesCalendar = loo_JResp.StringOf("ticket_metrics[i].first_resolution_time_in_minutes.calendar")
ls_Full_resolution_time_in_minutesBusiness = loo_JResp.StringOf("ticket_metrics[i].full_resolution_time_in_minutes.business")
ls_Full_resolution_time_in_minutesCalendar = loo_JResp.StringOf("ticket_metrics[i].full_resolution_time_in_minutes.calendar")
ls_Group_stations = loo_JResp.StringOf("ticket_metrics[i].group_stations")
ls_Id = loo_JResp.StringOf("ticket_metrics[i].id")
ls_Initially_assigned_at = loo_JResp.StringOf("ticket_metrics[i].initially_assigned_at")
ls_Latest_comment_added_at = loo_JResp.StringOf("ticket_metrics[i].latest_comment_added_at")
ls_On_hold_time_in_minutesBusiness = loo_JResp.StringOf("ticket_metrics[i].on_hold_time_in_minutes.business")
ls_On_hold_time_in_minutesCalendar = loo_JResp.StringOf("ticket_metrics[i].on_hold_time_in_minutes.calendar")
ls_Reopens = loo_JResp.StringOf("ticket_metrics[i].reopens")
ls_Replies = loo_JResp.StringOf("ticket_metrics[i].replies")
ls_Reply_time_in_minutesBusiness = loo_JResp.StringOf("ticket_metrics[i].reply_time_in_minutes.business")
ls_Reply_time_in_minutesCalendar = loo_JResp.StringOf("ticket_metrics[i].reply_time_in_minutes.calendar")
ls_Reply_time_in_secondsBusiness = loo_JResp.StringOf("ticket_metrics[i].reply_time_in_seconds.business")
ls_Reply_time_in_secondsCalendar = loo_JResp.StringOf("ticket_metrics[i].reply_time_in_seconds.calendar")
ls_Requester_updated_at = loo_JResp.StringOf("ticket_metrics[i].requester_updated_at")
ls_Requester_wait_time_in_minutesBusiness = loo_JResp.StringOf("ticket_metrics[i].requester_wait_time_in_minutes.business")
ls_Requester_wait_time_in_minutesCalendar = loo_JResp.StringOf("ticket_metrics[i].requester_wait_time_in_minutes.calendar")
ls_Solved_at = loo_JResp.StringOf("ticket_metrics[i].solved_at")
ls_Status_updated_at = loo_JResp.StringOf("ticket_metrics[i].status_updated_at")
ls_Ticket_id = loo_JResp.StringOf("ticket_metrics[i].ticket_id")
ls_Updated_at = loo_JResp.StringOf("ticket_metrics[i].updated_at")
ls_Url = loo_JResp.StringOf("ticket_metrics[i].url")
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_metrics
Postman Collection Item JSON
{
"name": "List Ticket Metrics",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ticket_metrics",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_metrics"
]
},
"description": "Returns a list of tickets with their metrics.\n\nTickets are ordered chronologically by created date, from newest to oldest.\nThe last ticket listed may not be the absolute oldest ticket in your account\ndue to ticket archiving.\n\nArchived tickets are not included in the response. See\n[About archived tickets](https://support.zendesk.com/hc/en-us/articles/203657756) in\nZendesk help.\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\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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_metrics"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"ticket_metrics\": [\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}"
}
]
}
