Chilkat Online Tools

Node.js / Support API / Show Ticket Metrics

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "login";
    http.Password = "password";

    http.SetRequestHeader("Accept","application/json");

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/ticket_metrics/:ticket_metric_id",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastHeader);
        console.log("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;
    var Calendar;
    var assigned_at;
    var assignee_stations;
    var assignee_updated_at;
    var created_at;
    var custom_status_updated_at;
    var first_resolution_time_in_minutesBusiness;
    var first_resolution_time_in_minutesCalendar;
    var full_resolution_time_in_minutesBusiness;
    var full_resolution_time_in_minutesCalendar;
    var group_stations;
    var id;
    var initially_assigned_at;
    var latest_comment_added_at;
    var on_hold_time_in_minutesBusiness;
    var on_hold_time_in_minutesCalendar;
    var reopens;
    var replies;
    var reply_time_in_minutesBusiness;
    var reply_time_in_minutesCalendar;
    var reply_time_in_secondsBusiness;
    var reply_time_in_secondsCalendar;
    var requester_updated_at;
    var requester_wait_time_in_minutesBusiness;
    var requester_wait_time_in_minutesCalendar;
    var solved_at;
    var status_updated_at;
    var ticket_id;
    var updated_at;
    var url;

    var i = 0;
    var count_i = jResp.SizeOfArray("ticket_metric");
    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;
    }


}

chilkatExample();

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