delphiDll / Support API / List Ticket Metrics
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Business: PWideChar;
Calendar: PWideChar;
assigned_at: PWideChar;
assignee_stations: PWideChar;
assignee_updated_at: PWideChar;
created_at: PWideChar;
custom_status_updated_at: PWideChar;
first_resolution_time_in_minutesBusiness: PWideChar;
first_resolution_time_in_minutesCalendar: PWideChar;
full_resolution_time_in_minutesBusiness: PWideChar;
full_resolution_time_in_minutesCalendar: PWideChar;
group_stations: PWideChar;
id: PWideChar;
initially_assigned_at: PWideChar;
latest_comment_added_at: PWideChar;
on_hold_time_in_minutesBusiness: PWideChar;
on_hold_time_in_minutesCalendar: PWideChar;
reopens: PWideChar;
replies: PWideChar;
reply_time_in_minutesBusiness: PWideChar;
reply_time_in_minutesCalendar: PWideChar;
reply_time_in_secondsBusiness: PWideChar;
reply_time_in_secondsCalendar: PWideChar;
requester_updated_at: PWideChar;
requester_wait_time_in_minutesBusiness: PWideChar;
requester_wait_time_in_minutesCalendar: PWideChar;
solved_at: PWideChar;
status_updated_at: PWideChar;
ticket_id: PWideChar;
updated_at: PWideChar;
url: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'password');
CkHttp_SetRequestHeader(http,'Accept','application/json');
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/ticket_metrics',sbResponseBody);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttp__lastHeader(http));
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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;
count_i := CkJsonObject_SizeOfArray(jResp,'ticket_metrics');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
Business := CkJsonObject__stringOf(jResp,'ticket_metrics[i].agent_wait_time_in_minutes.business');
Calendar := CkJsonObject__stringOf(jResp,'ticket_metrics[i].agent_wait_time_in_minutes.calendar');
assigned_at := CkJsonObject__stringOf(jResp,'ticket_metrics[i].assigned_at');
assignee_stations := CkJsonObject__stringOf(jResp,'ticket_metrics[i].assignee_stations');
assignee_updated_at := CkJsonObject__stringOf(jResp,'ticket_metrics[i].assignee_updated_at');
created_at := CkJsonObject__stringOf(jResp,'ticket_metrics[i].created_at');
custom_status_updated_at := CkJsonObject__stringOf(jResp,'ticket_metrics[i].custom_status_updated_at');
first_resolution_time_in_minutesBusiness := CkJsonObject__stringOf(jResp,'ticket_metrics[i].first_resolution_time_in_minutes.business');
first_resolution_time_in_minutesCalendar := CkJsonObject__stringOf(jResp,'ticket_metrics[i].first_resolution_time_in_minutes.calendar');
full_resolution_time_in_minutesBusiness := CkJsonObject__stringOf(jResp,'ticket_metrics[i].full_resolution_time_in_minutes.business');
full_resolution_time_in_minutesCalendar := CkJsonObject__stringOf(jResp,'ticket_metrics[i].full_resolution_time_in_minutes.calendar');
group_stations := CkJsonObject__stringOf(jResp,'ticket_metrics[i].group_stations');
id := CkJsonObject__stringOf(jResp,'ticket_metrics[i].id');
initially_assigned_at := CkJsonObject__stringOf(jResp,'ticket_metrics[i].initially_assigned_at');
latest_comment_added_at := CkJsonObject__stringOf(jResp,'ticket_metrics[i].latest_comment_added_at');
on_hold_time_in_minutesBusiness := CkJsonObject__stringOf(jResp,'ticket_metrics[i].on_hold_time_in_minutes.business');
on_hold_time_in_minutesCalendar := CkJsonObject__stringOf(jResp,'ticket_metrics[i].on_hold_time_in_minutes.calendar');
reopens := CkJsonObject__stringOf(jResp,'ticket_metrics[i].reopens');
replies := CkJsonObject__stringOf(jResp,'ticket_metrics[i].replies');
reply_time_in_minutesBusiness := CkJsonObject__stringOf(jResp,'ticket_metrics[i].reply_time_in_minutes.business');
reply_time_in_minutesCalendar := CkJsonObject__stringOf(jResp,'ticket_metrics[i].reply_time_in_minutes.calendar');
reply_time_in_secondsBusiness := CkJsonObject__stringOf(jResp,'ticket_metrics[i].reply_time_in_seconds.business');
reply_time_in_secondsCalendar := CkJsonObject__stringOf(jResp,'ticket_metrics[i].reply_time_in_seconds.calendar');
requester_updated_at := CkJsonObject__stringOf(jResp,'ticket_metrics[i].requester_updated_at');
requester_wait_time_in_minutesBusiness := CkJsonObject__stringOf(jResp,'ticket_metrics[i].requester_wait_time_in_minutes.business');
requester_wait_time_in_minutesCalendar := CkJsonObject__stringOf(jResp,'ticket_metrics[i].requester_wait_time_in_minutes.calendar');
solved_at := CkJsonObject__stringOf(jResp,'ticket_metrics[i].solved_at');
status_updated_at := CkJsonObject__stringOf(jResp,'ticket_metrics[i].status_updated_at');
ticket_id := CkJsonObject__stringOf(jResp,'ticket_metrics[i].ticket_id');
updated_at := CkJsonObject__stringOf(jResp,'ticket_metrics[i].updated_at');
url := CkJsonObject__stringOf(jResp,'ticket_metrics[i].url');
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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}"
}
]
}
