Chilkat Online Tools

lianja / Support API / Show Ticket Metrics

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/ticket_metrics/:ticket_metric_id",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

// 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

i = 0
lnCount_i = loJResp.SizeOfArray("ticket_metric")
do while i < lnCount_i
    loJResp.I = i
    lcBusiness = loJResp.StringOf("ticket_metric[i].agent_wait_time_in_minutes.business")
    lcCalendar = loJResp.StringOf("ticket_metric[i].agent_wait_time_in_minutes.calendar")
    lcAssigned_at = loJResp.StringOf("ticket_metric[i].assigned_at")
    lcAssignee_stations = loJResp.StringOf("ticket_metric[i].assignee_stations")
    lcAssignee_updated_at = loJResp.StringOf("ticket_metric[i].assignee_updated_at")
    lcCreated_at = loJResp.StringOf("ticket_metric[i].created_at")
    lcCustom_status_updated_at = loJResp.StringOf("ticket_metric[i].custom_status_updated_at")
    lcFirst_resolution_time_in_minutesBusiness = loJResp.StringOf("ticket_metric[i].first_resolution_time_in_minutes.business")
    lcFirst_resolution_time_in_minutesCalendar = loJResp.StringOf("ticket_metric[i].first_resolution_time_in_minutes.calendar")
    lcFull_resolution_time_in_minutesBusiness = loJResp.StringOf("ticket_metric[i].full_resolution_time_in_minutes.business")
    lcFull_resolution_time_in_minutesCalendar = loJResp.StringOf("ticket_metric[i].full_resolution_time_in_minutes.calendar")
    lcGroup_stations = loJResp.StringOf("ticket_metric[i].group_stations")
    lcId = loJResp.StringOf("ticket_metric[i].id")
    lcInitially_assigned_at = loJResp.StringOf("ticket_metric[i].initially_assigned_at")
    lcLatest_comment_added_at = loJResp.StringOf("ticket_metric[i].latest_comment_added_at")
    lcOn_hold_time_in_minutesBusiness = loJResp.StringOf("ticket_metric[i].on_hold_time_in_minutes.business")
    lcOn_hold_time_in_minutesCalendar = loJResp.StringOf("ticket_metric[i].on_hold_time_in_minutes.calendar")
    lcReopens = loJResp.StringOf("ticket_metric[i].reopens")
    lcReplies = loJResp.StringOf("ticket_metric[i].replies")
    lcReply_time_in_minutesBusiness = loJResp.StringOf("ticket_metric[i].reply_time_in_minutes.business")
    lcReply_time_in_minutesCalendar = loJResp.StringOf("ticket_metric[i].reply_time_in_minutes.calendar")
    lcReply_time_in_secondsBusiness = loJResp.StringOf("ticket_metric[i].reply_time_in_seconds.business")
    lcReply_time_in_secondsCalendar = loJResp.StringOf("ticket_metric[i].reply_time_in_seconds.calendar")
    lcRequester_updated_at = loJResp.StringOf("ticket_metric[i].requester_updated_at")
    lcRequester_wait_time_in_minutesBusiness = loJResp.StringOf("ticket_metric[i].requester_wait_time_in_minutes.business")
    lcRequester_wait_time_in_minutesCalendar = loJResp.StringOf("ticket_metric[i].requester_wait_time_in_minutes.calendar")
    lcSolved_at = loJResp.StringOf("ticket_metric[i].solved_at")
    lcStatus_updated_at = loJResp.StringOf("ticket_metric[i].status_updated_at")
    lcTicket_id = loJResp.StringOf("ticket_metric[i].ticket_id")
    lcUpdated_at = loJResp.StringOf("ticket_metric[i].updated_at")
    lcUrl = loJResp.StringOf("ticket_metric[i].url")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

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}"
    }
  ]
}