C / Support API / Count Tickets in View
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *Active;
const char *Fresh;
const char *Pretty;
const char *v_Url;
const char *Value;
const char *View_id;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"password");
CkHttp_SetRequestHeader(http,"Accept","application/json");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/views/:view_id/count",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "view_count": {
// "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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Active = CkJsonObject_stringOf(jResp,"view_count.active");
Fresh = CkJsonObject_stringOf(jResp,"view_count.fresh");
Pretty = CkJsonObject_stringOf(jResp,"view_count.pretty");
v_Url = CkJsonObject_stringOf(jResp,"view_count.url");
Value = CkJsonObject_stringOf(jResp,"view_count.value");
View_id = CkJsonObject_stringOf(jResp,"view_count.view_id");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/views/:view_id/count
Postman Collection Item JSON
{
"name": "Count Tickets in View",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/views/:view_id/count",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views",
":view_id",
"count"
],
"variable": [
{
"key": "view_id",
"value": "<integer>"
}
]
},
"description": "Returns the ticket count for a single view.\n\nThis endpoint is rate limited to 5 requests per minute, per view, per agent.\n\n#### View Counts\n\nThe view count endpoints, Count Tickets in View (this endpoint) and [Count Tickets in Views](#count-tickets-in-views), let you estimate how many tickets remain in a view without having to retrieve the entire view. They're designed to help estimate view size. From a business perspective, accuracy becomes less relevant as view size increases.\n\nTo ensure quality of service, these counts are cached more heavily as the number of tickets in a view grows. For a view with thousands of tickets, you can expect the count to be cached for 60-90 minutes. As a result, the count may not reflect the actual number of tickets in your view.\n\nView counts are represented as JSON objects with the following attributes:\n\n| Name | Type | Comment\n| --------------- | ------------| -------\n| view_id | integer | The id of the view\n| url | string | The API url of the count\n| value | integer | The cached number of tickets in the view. Can also be null if the system is loading and caching new data. Not to be confused with 0 tickets\n| pretty | string | A pretty-printed text approximation of the view count\n| fresh | boolean | false if the cached data is stale and the system is still loading and caching new data\n| active | boolean | Only active views if true, inactive views if false, all views if null.\n\n#### Example\n```js\n{\n \"view_count\": {\n \"view_id\": 25,\n \"url\": \"https://company.zendesk.com/api/v2/views/25/count.json\",\n \"value\": 719,\n \"pretty\": \"~700\",\n \"fresh\": true\n }\n}\n```\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/:view_id/count",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views",
":view_id",
"count"
],
"variable": [
{
"key": "view_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"view_count\": {\n \"active\": \"<boolean>\",\n \"fresh\": \"<boolean>\",\n \"pretty\": \"<string>\",\n \"url\": \"<string>\",\n \"value\": \"<integer>\",\n \"view_id\": \"<integer>\"\n }\n}"
}
]
}
