Chilkat Online Tools

lianja / 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.

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("ids","<string>")

loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/views/count_many",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loQueryParams
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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

i = 0
lnCount_i = loJResp.SizeOfArray("view_counts")
do while i < lnCount_i
    loJResp.I = i
    lcActive = loJResp.StringOf("view_counts[i].active")
    lcFresh = loJResp.StringOf("view_counts[i].fresh")
    lcPretty = loJResp.StringOf("view_counts[i].pretty")
    lcUrl = loJResp.StringOf("view_counts[i].url")
    lcValue = loJResp.StringOf("view_counts[i].value")
    lcView_id = loJResp.StringOf("view_counts[i].view_id")
    i = i + 1
enddo


release loHttp
release loQueryParams
release loSbResponseBody
release loJResp

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