Chilkat Online Tools

C++ / Support API / Incremental Ticket Export, Cursor Based

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login("login");
    http.put_Password("password");

    CkJsonObject queryParams;
    queryParams.UpdateString("start_time","<integer>");
    queryParams.UpdateString("cursor","<string>");

    http.SetRequestHeader("Accept","application/json");

    CkHttpResponse *resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/tickets/cursor",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "after_cursor": "<string>",
    //   "after_url": "<string>",
    //   "before_cursor": "<string>",
    //   "before_url": "<string>",
    //   "end_of_stream": "<boolean>",
    //   "tickets": [
    //     {
    //       "requester_id": "<integer>",
    //       "allow_attachments": "<boolean>",
    //       "allow_channelback": "<boolean>",
    //       "assignee_email": "<string>",
    //       "assignee_id": "<integer>",
    //       "attribute_value_ids": "<array>",
    //       "brand_id": "<integer>",
    //       "collaborator_ids": "<array>",
    //       "collaborators": [
    //         {
    //           "email": "<email>",
    //           "name": "<string>"
    //         },
    //         {
    //           "email": "<email>",
    //           "name": "<string>"
    //         }
    //       ],
    //       "comment": {},
    //       "created_at": "<dateTime>",
    //       "custom_fields": "<array>",
    //       "custom_status_id": "<integer>",
    //       "description": "<string>",
    //       "due_at": "<dateTime>",
    //       "email_cc_ids": "<array>",
    //       "email_ccs": {},
    //       "external_id": "<string>",
    //       "follower_ids": "<array>",
    //       "followers": {},
    //       "followup_ids": "<array>",
    //       "forum_topic_id": "<integer>",
    //       "from_messaging_channel": "<boolean>",
    //       "group_id": "<integer>",
    //       "has_incidents": "<boolean>",
    //       "id": "<integer>",
    //       "is_public": "<boolean>",
    //       "macro_id": "<integer>",
    //       "macro_ids": "<array>",
    //       "metadata": {},
    //       "organization_id": "<integer>",
    //       "priority": "urgent",
    //       "problem_id": "<integer>",
    //       "raw_subject": "<string>",
    //       "recipient": "<string>",
    //       "requester": {},
    //       "safe_update": "<boolean>",
    //       "satisfaction_rating": {
    //         "non9": 3831085,
    //         "eiusmod_3": 57077767.014250696
    //       },
    //       "sharing_agreement_ids": "<array>",
    //       "status": "solved",
    //       "subject": "<string>",
    //       "submitter_id": "<integer>",
    //       "tags": "<array>",
    //       "ticket_form_id": "<integer>",
    //       "type": "task",
    //       "updated_at": "<dateTime>",
    //       "updated_stamp": "<string>",
    //       "url": "<string>",
    //       "via": {
    //         "channel": "<string>",
    //         "source": {
    //           "in4": 87803065,
    //           "in57": "velit ipsum"
    //         }
    //       },
    //       "via_followup_source_id": "<integer>",
    //       "via_id": "<integer>",
    //       "voice_comment": {}
    //     },
    //     {
    //       "requester_id": "<integer>",
    //       "allow_attachments": "<boolean>",
    //       "allow_channelback": "<boolean>",
    //       "assignee_email": "<string>",
    //       "assignee_id": "<integer>",
    //       "attribute_value_ids": "<array>",
    //       "brand_id": "<integer>",
    //       "collaborator_ids": "<array>",
    //       "collaborators": [
    //         {
    //           "email": "<email>",
    //           "name": "<string>"
    //         },
    //         {
    //           "email": "<email>",
    //           "name": "<string>"
    //         }
    //       ],
    //       "comment": {},
    //       "created_at": "<dateTime>",
    //       "custom_fields": "<array>",
    //       "custom_status_id": "<integer>",
    //       "description": "<string>",
    //       "due_at": "<dateTime>",
    //       "email_cc_ids": "<array>",
    //       "email_ccs": {},
    //       "external_id": "<string>",
    //       "follower_ids": "<array>",
    //       "followers": {},
    //       "followup_ids": "<array>",
    //       "forum_topic_id": "<integer>",
    //       "from_messaging_channel": "<boolean>",
    //       "group_id": "<integer>",
    //       "has_incidents": "<boolean>",
    //       "id": "<integer>",
    //       "is_public": "<boolean>",
    //       "macro_id": "<integer>",
    //       "macro_ids": "<array>",
    //       "metadata": {},
    //       "organization_id": "<integer>",
    //       "priority": "low",
    //       "problem_id": "<integer>",
    //       "raw_subject": "<string>",
    //       "recipient": "<string>",
    //       "requester": {},
    //       "safe_update": "<boolean>",
    //       "satisfaction_rating": {
    //         "id_b": "qui dolore"
    //       },
    //       "sharing_agreement_ids": "<array>",
    //       "status": "pending",
    //       "subject": "<string>",
    //       "submitter_id": "<integer>",
    //       "tags": "<array>",
    //       "ticket_form_id": "<integer>",
    //       "type": "question",
    //       "updated_at": "<dateTime>",
    //       "updated_stamp": "<string>",
    //       "url": "<string>",
    //       "via": {
    //         "channel": "<string>",
    //         "source": {
    //           "ea___9": -17544125
    //         }
    //       },
    //       "via_followup_source_id": "<integer>",
    //       "via_id": "<integer>",
    //       "voice_comment": {}
    //     }
    //   ]
    // }

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

    const char *requester_id = 0;
    const char *allow_attachments = 0;
    const char *allow_channelback = 0;
    const char *assignee_email = 0;
    const char *assignee_id = 0;
    const char *attribute_value_ids = 0;
    const char *brand_id = 0;
    const char *collaborator_ids = 0;
    const char *created_at = 0;
    const char *custom_fields = 0;
    const char *custom_status_id = 0;
    const char *description = 0;
    const char *due_at = 0;
    const char *email_cc_ids = 0;
    const char *external_id = 0;
    const char *follower_ids = 0;
    const char *followup_ids = 0;
    const char *forum_topic_id = 0;
    const char *from_messaging_channel = 0;
    const char *group_id = 0;
    const char *has_incidents = 0;
    const char *id = 0;
    const char *is_public = 0;
    const char *macro_id = 0;
    const char *macro_ids = 0;
    const char *organization_id = 0;
    const char *priority = 0;
    const char *problem_id = 0;
    const char *raw_subject = 0;
    const char *recipient = 0;
    const char *safe_update = 0;
    int Non9;
    const char *Eiusmod_3 = 0;
    const char *sharing_agreement_ids = 0;
    const char *status = 0;
    const char *subject = 0;
    const char *submitter_id = 0;
    const char *tags = 0;
    const char *ticket_form_id = 0;
    const char *v_type = 0;
    const char *updated_at = 0;
    const char *updated_stamp = 0;
    const char *url = 0;
    const char *Channel = 0;
    int In4;
    const char *In57 = 0;
    const char *via_followup_source_id = 0;
    const char *via_id = 0;
    const char *Id_b = 0;
    int Ea___9;
    int j;
    int count_j;
    const char *email = 0;
    const char *name = 0;

    const char *after_cursor = jResp.stringOf("after_cursor");
    const char *after_url = jResp.stringOf("after_url");
    const char *before_cursor = jResp.stringOf("before_cursor");
    const char *before_url = jResp.stringOf("before_url");
    const char *end_of_stream = jResp.stringOf("end_of_stream");
    int i = 0;
    int count_i = jResp.SizeOfArray("tickets");
    while (i < count_i) {
        jResp.put_I(i);
        requester_id = jResp.stringOf("tickets[i].requester_id");
        allow_attachments = jResp.stringOf("tickets[i].allow_attachments");
        allow_channelback = jResp.stringOf("tickets[i].allow_channelback");
        assignee_email = jResp.stringOf("tickets[i].assignee_email");
        assignee_id = jResp.stringOf("tickets[i].assignee_id");
        attribute_value_ids = jResp.stringOf("tickets[i].attribute_value_ids");
        brand_id = jResp.stringOf("tickets[i].brand_id");
        collaborator_ids = jResp.stringOf("tickets[i].collaborator_ids");
        created_at = jResp.stringOf("tickets[i].created_at");
        custom_fields = jResp.stringOf("tickets[i].custom_fields");
        custom_status_id = jResp.stringOf("tickets[i].custom_status_id");
        description = jResp.stringOf("tickets[i].description");
        due_at = jResp.stringOf("tickets[i].due_at");
        email_cc_ids = jResp.stringOf("tickets[i].email_cc_ids");
        external_id = jResp.stringOf("tickets[i].external_id");
        follower_ids = jResp.stringOf("tickets[i].follower_ids");
        followup_ids = jResp.stringOf("tickets[i].followup_ids");
        forum_topic_id = jResp.stringOf("tickets[i].forum_topic_id");
        from_messaging_channel = jResp.stringOf("tickets[i].from_messaging_channel");
        group_id = jResp.stringOf("tickets[i].group_id");
        has_incidents = jResp.stringOf("tickets[i].has_incidents");
        id = jResp.stringOf("tickets[i].id");
        is_public = jResp.stringOf("tickets[i].is_public");
        macro_id = jResp.stringOf("tickets[i].macro_id");
        macro_ids = jResp.stringOf("tickets[i].macro_ids");
        organization_id = jResp.stringOf("tickets[i].organization_id");
        priority = jResp.stringOf("tickets[i].priority");
        problem_id = jResp.stringOf("tickets[i].problem_id");
        raw_subject = jResp.stringOf("tickets[i].raw_subject");
        recipient = jResp.stringOf("tickets[i].recipient");
        safe_update = jResp.stringOf("tickets[i].safe_update");
        Non9 = jResp.IntOf("tickets[i].satisfaction_rating.non9");
        Eiusmod_3 = jResp.stringOf("tickets[i].satisfaction_rating.eiusmod_3");
        sharing_agreement_ids = jResp.stringOf("tickets[i].sharing_agreement_ids");
        status = jResp.stringOf("tickets[i].status");
        subject = jResp.stringOf("tickets[i].subject");
        submitter_id = jResp.stringOf("tickets[i].submitter_id");
        tags = jResp.stringOf("tickets[i].tags");
        ticket_form_id = jResp.stringOf("tickets[i].ticket_form_id");
        v_type = jResp.stringOf("tickets[i].type");
        updated_at = jResp.stringOf("tickets[i].updated_at");
        updated_stamp = jResp.stringOf("tickets[i].updated_stamp");
        url = jResp.stringOf("tickets[i].url");
        Channel = jResp.stringOf("tickets[i].via.channel");
        In4 = jResp.IntOf("tickets[i].via.source.in4");
        In57 = jResp.stringOf("tickets[i].via.source.in57");
        via_followup_source_id = jResp.stringOf("tickets[i].via_followup_source_id");
        via_id = jResp.stringOf("tickets[i].via_id");
        Id_b = jResp.stringOf("tickets[i].satisfaction_rating.id_b");
        Ea___9 = jResp.IntOf("tickets[i].via.source.ea___9");
        j = 0;
        count_j = jResp.SizeOfArray("tickets[i].collaborators");
        while (j < count_j) {
            jResp.put_J(j);
            email = jResp.stringOf("tickets[i].collaborators[j].email");
            name = jResp.stringOf("tickets[i].collaborators[j].name");
            j = j + 1;
        }

        i = i + 1;
    }
    }

Curl Command

curl  -u login:password -G -d "start_time=%3Cinteger%3E"
	-d "cursor=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/tickets/cursor

Postman Collection Item JSON

{
  "name": "Incremental Ticket Export, Cursor Based",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/incremental/tickets/cursor?start_time=<integer>&cursor=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "incremental",
        "tickets",
        "cursor"
      ],
      "query": [
        {
          "key": "start_time",
          "value": "<integer>",
          "description": "(Required) The time to start the incremental export from"
        },
        {
          "key": "cursor",
          "value": "<string>",
          "description": "The cursor pointer to work with for all subsequent exports after the initial request"
        }
      ]
    },
    "description": "Returns the tickets that changed since the start time. For more information,\nsee [Exporting tickets](/documentation/ticketing/managing-tickets/using-the-incremental-export-api#exporting-tickets) in [Using the Incremental Exports API](/documentation/ticketing/managing-tickets/using-the-incremental-export-api).\n\nThis endpoint supports cursor-based incremental exports.\nCursor-based exports are highly encouraged because they provide more consistent performance and\nresponse body sizes. For more information, see [Cursor-based incremental exports](/documentation/ticketing/managing-tickets/using-the-incremental-export-api#cursor-based-incremental-exports) in [Using the Incremental Exports API](/documentation/ticketing/managing-tickets/using-the-incremental-export-api).\n\n\n\n#### Allowed For\n\n * Admins\n\n#### Sideloading\n\nSee [Tickets sideloads](/documentation/ticketing/using-the-zendesk-api/side_loading/#supported-endpoints). For performance reasons,\n`last_audits` sideloads aren't supported.\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/incremental/tickets/cursor?start_time=<integer>&cursor=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "incremental",
            "tickets",
            "cursor"
          ],
          "query": [
            {
              "key": "start_time",
              "value": "<integer>",
              "description": "(Required) The time to start the incremental export from"
            },
            {
              "key": "cursor",
              "value": "<string>",
              "description": "The cursor pointer to work with for all subsequent exports after the initial request"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"after_cursor\": \"<string>\",\n  \"after_url\": \"<string>\",\n  \"before_cursor\": \"<string>\",\n  \"before_url\": \"<string>\",\n  \"end_of_stream\": \"<boolean>\",\n  \"tickets\": [\n    {\n      \"requester_id\": \"<integer>\",\n      \"allow_attachments\": \"<boolean>\",\n      \"allow_channelback\": \"<boolean>\",\n      \"assignee_email\": \"<string>\",\n      \"assignee_id\": \"<integer>\",\n      \"attribute_value_ids\": \"<array>\",\n      \"brand_id\": \"<integer>\",\n      \"collaborator_ids\": \"<array>\",\n      \"collaborators\": [\n        {\n          \"email\": \"<email>\",\n          \"name\": \"<string>\"\n        },\n        {\n          \"email\": \"<email>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"comment\": {},\n      \"created_at\": \"<dateTime>\",\n      \"custom_fields\": \"<array>\",\n      \"custom_status_id\": \"<integer>\",\n      \"description\": \"<string>\",\n      \"due_at\": \"<dateTime>\",\n      \"email_cc_ids\": \"<array>\",\n      \"email_ccs\": {},\n      \"external_id\": \"<string>\",\n      \"follower_ids\": \"<array>\",\n      \"followers\": {},\n      \"followup_ids\": \"<array>\",\n      \"forum_topic_id\": \"<integer>\",\n      \"from_messaging_channel\": \"<boolean>\",\n      \"group_id\": \"<integer>\",\n      \"has_incidents\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"macro_id\": \"<integer>\",\n      \"macro_ids\": \"<array>\",\n      \"metadata\": {},\n      \"organization_id\": \"<integer>\",\n      \"priority\": \"urgent\",\n      \"problem_id\": \"<integer>\",\n      \"raw_subject\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"requester\": {},\n      \"safe_update\": \"<boolean>\",\n      \"satisfaction_rating\": {\n        \"non9\": 3831085,\n        \"eiusmod_3\": 57077767.014250696\n      },\n      \"sharing_agreement_ids\": \"<array>\",\n      \"status\": \"solved\",\n      \"subject\": \"<string>\",\n      \"submitter_id\": \"<integer>\",\n      \"tags\": \"<array>\",\n      \"ticket_form_id\": \"<integer>\",\n      \"type\": \"task\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_stamp\": \"<string>\",\n      \"url\": \"<string>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"in4\": 87803065,\n          \"in57\": \"velit ipsum\"\n        }\n      },\n      \"via_followup_source_id\": \"<integer>\",\n      \"via_id\": \"<integer>\",\n      \"voice_comment\": {}\n    },\n    {\n      \"requester_id\": \"<integer>\",\n      \"allow_attachments\": \"<boolean>\",\n      \"allow_channelback\": \"<boolean>\",\n      \"assignee_email\": \"<string>\",\n      \"assignee_id\": \"<integer>\",\n      \"attribute_value_ids\": \"<array>\",\n      \"brand_id\": \"<integer>\",\n      \"collaborator_ids\": \"<array>\",\n      \"collaborators\": [\n        {\n          \"email\": \"<email>\",\n          \"name\": \"<string>\"\n        },\n        {\n          \"email\": \"<email>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"comment\": {},\n      \"created_at\": \"<dateTime>\",\n      \"custom_fields\": \"<array>\",\n      \"custom_status_id\": \"<integer>\",\n      \"description\": \"<string>\",\n      \"due_at\": \"<dateTime>\",\n      \"email_cc_ids\": \"<array>\",\n      \"email_ccs\": {},\n      \"external_id\": \"<string>\",\n      \"follower_ids\": \"<array>\",\n      \"followers\": {},\n      \"followup_ids\": \"<array>\",\n      \"forum_topic_id\": \"<integer>\",\n      \"from_messaging_channel\": \"<boolean>\",\n      \"group_id\": \"<integer>\",\n      \"has_incidents\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"macro_id\": \"<integer>\",\n      \"macro_ids\": \"<array>\",\n      \"metadata\": {},\n      \"organization_id\": \"<integer>\",\n      \"priority\": \"low\",\n      \"problem_id\": \"<integer>\",\n      \"raw_subject\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"requester\": {},\n      \"safe_update\": \"<boolean>\",\n      \"satisfaction_rating\": {\n        \"id_b\": \"qui dolore\"\n      },\n      \"sharing_agreement_ids\": \"<array>\",\n      \"status\": \"pending\",\n      \"subject\": \"<string>\",\n      \"submitter_id\": \"<integer>\",\n      \"tags\": \"<array>\",\n      \"ticket_form_id\": \"<integer>\",\n      \"type\": \"question\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_stamp\": \"<string>\",\n      \"url\": \"<string>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"ea___9\": -17544125\n        }\n      },\n      \"via_followup_source_id\": \"<integer>\",\n      \"via_id\": \"<integer>\",\n      \"voice_comment\": {}\n    }\n  ]\n}"
    }
  ]
}