TCL / Support API / Count Tickets in Views
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "ids" "<string>"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://example.zendesk.com/api/v2/views/count_many" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "view_counts"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set active [CkJsonObject_stringOf $jResp "view_counts[i].active"]
set fresh [CkJsonObject_stringOf $jResp "view_counts[i].fresh"]
set pretty [CkJsonObject_stringOf $jResp "view_counts[i].pretty"]
set url [CkJsonObject_stringOf $jResp "view_counts[i].url"]
set value [CkJsonObject_stringOf $jResp "view_counts[i].value"]
set view_id [CkJsonObject_stringOf $jResp "view_counts[i].view_id"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}