Chilkat Online Tools

autoit / Support API / Count Tickets in Views

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_9_5_0.Http")
Local $bSuccess

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

$oQueryParams = ObjCreate("Chilkat_9_5_0.JsonObject")
$oQueryParams.UpdateString("ids","<string>")

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

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

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

$oJResp = ObjCreate("Chilkat_9_5_0.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)

; {
;   "view_counts": [
;     {
;       "active": "<boolean>",
;       "fresh": "<boolean>",
;       "pretty": "<string>",
;       "url": "<string>",
;       "value": "<integer>",
;       "view_id": "<integer>"
;     },
;     {
;       "active": "<boolean>",
;       "fresh": "<boolean>",
;       "pretty": "<string>",
;       "url": "<string>",
;       "value": "<integer>",
;       "view_id": "<integer>"
;     }
;   ]
; }

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

Local $sActive
Local $sFresh
Local $sPretty
Local $sUrl
Local $sValue
Local $sView_id

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("view_counts")
While $i < $iCount_i
    $oJResp.I = $i
    $sActive = $oJResp.StringOf("view_counts[i].active")
    $sFresh = $oJResp.StringOf("view_counts[i].fresh")
    $sPretty = $oJResp.StringOf("view_counts[i].pretty")
    $sUrl = $oJResp.StringOf("view_counts[i].url")
    $sValue = $oJResp.StringOf("view_counts[i].value")
    $sView_id = $oJResp.StringOf("view_counts[i].view_id")
    $i = $i + 1
Wend

Curl Command

curl  -u login:password -G -d "ids=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/views/count_many

Postman Collection Item JSON

{
  "name": "Count Tickets in Views",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/views/count_many?ids=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "views",
        "count_many"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<string>",
          "description": "(Required) List of view's ids separated by commas."
        }
      ]
    },
    "description": "Returns the ticket count of each view in a list of views. Accepts up to 20 view ids per request. For the ticket count of a single view, see [Count Tickets in View](#count-tickets-in-view).\n\nOnly returns values for personal and shared views accessible to the user performing the request.\n\nThis endpoint is rate limited to 6 requests every 5 minutes.\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/views/count_many?ids=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "views",
            "count_many"
          ],
          "query": [
            {
              "key": "ids",
              "value": "<string>",
              "description": "(Required) List of view's ids separated by commas."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"view_counts\": [\n    {\n      \"active\": \"<boolean>\",\n      \"fresh\": \"<boolean>\",\n      \"pretty\": \"<string>\",\n      \"url\": \"<string>\",\n      \"value\": \"<integer>\",\n      \"view_id\": \"<integer>\"\n    },\n    {\n      \"active\": \"<boolean>\",\n      \"fresh\": \"<boolean>\",\n      \"pretty\": \"<string>\",\n      \"url\": \"<string>\",\n      \"value\": \"<integer>\",\n      \"view_id\": \"<integer>\"\n    }\n  ]\n}"
    }
  ]
}