Chilkat Online Tools

delphiAx / Support API / List Ticket Metric Events

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
id: WideString;
instance_id: WideString;
metric: WideString;
ticket_id: WideString;
time: WideString;
v_type: WideString;
count: WideString;
end_time: WideString;
next_page: WideString;
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 := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';

queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('start_time','<integer>');

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

resp := http.QuickRequestParams('GET','https://example.zendesk.com/api/v2/incremental/ticket_metric_events',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "ticket_metric_events": [
//     {
//       "id": "<integer>",
//       "instance_id": "<integer>",
//       "metric": "agent_work_time",
//       "ticket_id": "<integer>",
//       "time": "<dateTime>",
//       "type": "apply_sla"
//     },
//     {
//       "id": "<integer>",
//       "instance_id": "<integer>",
//       "metric": "pausable_update_time",
//       "ticket_id": "<integer>",
//       "time": "<dateTime>",
//       "type": "pause"
//     }
//   ],
//   "count": "<integer>",
//   "end_time": "<integer>",
//   "next_page": "<string>"
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

count := jResp.StringOf('count');
end_time := jResp.StringOf('end_time');
next_page := jResp.StringOf('next_page');
i := 0;
count_i := jResp.SizeOfArray('ticket_metric_events');
while i < count_i do
  begin
    jResp.I := i;
    id := jResp.StringOf('ticket_metric_events[i].id');
    instance_id := jResp.StringOf('ticket_metric_events[i].instance_id');
    metric := jResp.StringOf('ticket_metric_events[i].metric');
    ticket_id := jResp.StringOf('ticket_metric_events[i].ticket_id');
    time := jResp.StringOf('ticket_metric_events[i].time');
    v_type := jResp.StringOf('ticket_metric_events[i].type');
    i := i + 1;
  end;

Curl Command

curl  -u login:password -G -d "start_time=%3Cinteger%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/ticket_metric_events

Postman Collection Item JSON

{
  "name": "List Ticket Metric Events",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/incremental/ticket_metric_events?start_time=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "incremental",
        "ticket_metric_events"
      ],
      "query": [
        {
          "key": "start_time",
          "value": "<integer>",
          "description": "(Required) The Unix UTC epoch time of the oldest event you're interested in. Example: 1332034771."
        }
      ]
    },
    "description": "Returns ticket metric events that occurred on or after the start time.\n\nCursor pagination returns a maximum of 100 records per page. Events are listed in chronological order.\n\nIf the results are not paginated, events will be returned as a time-based incremental export.\n\nSee [Time-based incremental exports](/documentation/ticketing/managing-tickets/using-the-incremental-export-api#time-based-incremental-exports).\n\n#### Pagination\n* Cursor pagination\n* No pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\n#### Allowed For\n\n* Admins"
  },
  "response": [
    {
      "name": "Successful response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/incremental/ticket_metric_events?start_time=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "incremental",
            "ticket_metric_events"
          ],
          "query": [
            {
              "key": "start_time",
              "value": "<integer>",
              "description": "(Required) The Unix UTC epoch time of the oldest event you're interested in. Example: 1332034771."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"ticket_metric_events\": [\n    {\n      \"id\": \"<integer>\",\n      \"instance_id\": \"<integer>\",\n      \"metric\": \"agent_work_time\",\n      \"ticket_id\": \"<integer>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"apply_sla\"\n    },\n    {\n      \"id\": \"<integer>\",\n      \"instance_id\": \"<integer>\",\n      \"metric\": \"pausable_update_time\",\n      \"ticket_id\": \"<integer>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"pause\"\n    }\n  ],\n  \"count\": \"<integer>\",\n  \"end_time\": \"<integer>\",\n  \"next_page\": \"<string>\"\n}"
    }
  ]
}