Chilkat Online Tools

autoit / Support API / List Ticket Metric Events

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("start_time","<integer>")

$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/ticket_metric_events",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sId
Local $sInstance_id
Local $sMetric
Local $sTicket_id
Local $sTime
Local $sV_type

Local $sCount = $oJResp.StringOf("count")
Local $sEnd_time = $oJResp.StringOf("end_time")
Local $sNext_page = $oJResp.StringOf("next_page")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("ticket_metric_events")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("ticket_metric_events[i].id")
    $sInstance_id = $oJResp.StringOf("ticket_metric_events[i].instance_id")
    $sMetric = $oJResp.StringOf("ticket_metric_events[i].metric")
    $sTicket_id = $oJResp.StringOf("ticket_metric_events[i].ticket_id")
    $sTime = $oJResp.StringOf("ticket_metric_events[i].time")
    $sV_type = $oJResp.StringOf("ticket_metric_events[i].type")
    $i = $i + 1
Wend

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