Chilkat Online Tools

VBScript / Support API / List Ticket Metric Events

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

http.BasicAuth = 1
http.Login = "login"
http.Password = "password"

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set queryParams = CreateObject("Chilkat.JsonObject")
success = queryParams.UpdateString("start_time","<integer>")

http.SetRequestHeader "Accept","application/json"

' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/ticket_metric_events",queryParams)
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())

respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(resp.Header)
    outFile.WriteLine("Failed.")

    WScript.Quit
End If

' 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")
Do While i < count_i
    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
Loop

outFile.Close

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