unicodeC / Support API / Count Tickets in Views
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *active;
const wchar_t *fresh;
const wchar_t *pretty;
const wchar_t *url;
const wchar_t *value;
const wchar_t *view_id;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_putBasicAuth(http,TRUE);
CkHttpW_putLogin(http,L"login");
CkHttpW_putPassword(http,L"password");
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"ids",L"<string>");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://example.zendesk.com/api/v2/views/count_many",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"view_counts");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
active = CkJsonObjectW_stringOf(jResp,L"view_counts[i].active");
fresh = CkJsonObjectW_stringOf(jResp,L"view_counts[i].fresh");
pretty = CkJsonObjectW_stringOf(jResp,L"view_counts[i].pretty");
url = CkJsonObjectW_stringOf(jResp,L"view_counts[i].url");
value = CkJsonObjectW_stringOf(jResp,L"view_counts[i].value");
view_id = CkJsonObjectW_stringOf(jResp,L"view_counts[i].view_id");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(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}"
}
]
}