Objective-C / Support API / Incremental Sample Export
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";
CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"start_time" value: @"<integer>"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://example.zendesk.com/api/v2/incremental/:incremental_resource/sample" json: queryParams];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "count": "<integer>",
// "end_of_stream": "<boolean>",
// "end_time": "<integer>",
// "next_page": "<string>",
// "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": "high",
// "problem_id": "<integer>",
// "raw_subject": "<string>",
// "recipient": "<string>",
// "requester": {},
// "safe_update": "<boolean>",
// "satisfaction_rating": {
// "aliquad0": false
// },
// "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": {
// "elit2f": -86657295.30733354
// }
// },
// "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": "high",
// "problem_id": "<integer>",
// "raw_subject": "<string>",
// "recipient": "<string>",
// "requester": {},
// "safe_update": "<boolean>",
// "satisfaction_rating": {
// "minim_01": "minim tempor",
// "ipsum8c2": false
// },
// "sharing_agreement_ids": "<array>",
// "status": "open",
// "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": {
// "nostrud_ee": "dolore veniam consequat"
// }
// },
// "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
NSString *requester_id = 0;
NSString *allow_attachments = 0;
NSString *allow_channelback = 0;
NSString *assignee_email = 0;
NSString *assignee_id = 0;
NSString *attribute_value_ids = 0;
NSString *brand_id = 0;
NSString *collaborator_ids = 0;
NSString *created_at = 0;
NSString *custom_fields = 0;
NSString *custom_status_id = 0;
NSString *description = 0;
NSString *due_at = 0;
NSString *email_cc_ids = 0;
NSString *external_id = 0;
NSString *follower_ids = 0;
NSString *followup_ids = 0;
NSString *forum_topic_id = 0;
NSString *from_messaging_channel = 0;
NSString *group_id = 0;
NSString *has_incidents = 0;
NSString *id = 0;
NSString *is_public = 0;
NSString *macro_id = 0;
NSString *macro_ids = 0;
NSString *organization_id = 0;
NSString *priority = 0;
NSString *problem_id = 0;
NSString *raw_subject = 0;
NSString *recipient = 0;
NSString *safe_update = 0;
BOOL Aliquad0;
NSString *sharing_agreement_ids = 0;
NSString *status = 0;
NSString *subject = 0;
NSString *submitter_id = 0;
NSString *tags = 0;
NSString *ticket_form_id = 0;
NSString *v_type = 0;
NSString *updated_at = 0;
NSString *updated_stamp = 0;
NSString *url = 0;
NSString *Channel = 0;
NSString *Elit2f = 0;
NSString *via_followup_source_id = 0;
NSString *via_id = 0;
NSString *Minim_01 = 0;
BOOL Ipsum8c2;
NSString *Nostrud_ee = 0;
int j;
int count_j;
NSString *email = 0;
NSString *name = 0;
NSString *count = [jResp StringOf: @"count"];
NSString *end_of_stream = [jResp StringOf: @"end_of_stream"];
NSString *end_time = [jResp StringOf: @"end_time"];
NSString *next_page = [jResp StringOf: @"next_page"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"tickets"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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"];
Aliquad0 = [jResp BoolOf: @"tickets[i].satisfaction_rating.aliquad0"];
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"];
Elit2f = [jResp StringOf: @"tickets[i].via.source.elit2f"];
via_followup_source_id = [jResp StringOf: @"tickets[i].via_followup_source_id"];
via_id = [jResp StringOf: @"tickets[i].via_id"];
Minim_01 = [jResp StringOf: @"tickets[i].satisfaction_rating.minim_01"];
Ipsum8c2 = [jResp BoolOf: @"tickets[i].satisfaction_rating.ipsum8c2"];
Nostrud_ee = [jResp StringOf: @"tickets[i].via.source.nostrud_ee"];
j = 0;
count_j = [[jResp SizeOfArray: @"tickets[i].collaborators"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: 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"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/:incremental_resource/sample
Postman Collection Item JSON
{
"name": "Incremental Sample Export",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/incremental/:incremental_resource/sample?start_time=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
":incremental_resource",
"sample"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
}
],
"variable": [
{
"key": "incremental_resource",
"value": "<string>"
}
]
},
"description": "Use this endpoint to test the incremental export format. It's more strict in terms of rate limiting,\nat 10 requests per 20 minutes instead of 10 requests per minute. It also returns only up to 50\nresults per request. Otherwise, it's identical to the above APIs.\n\nUse the `incremental_resource` parameter to specify the resource. Possible values are \"tickets\", \"ticket_events\", \"users\", or \"organizations\".\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/:incremental_resource/sample?start_time=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
":incremental_resource",
"sample"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
}
],
"variable": [
{
"key": "incremental_resource"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"end_of_stream\": \"<boolean>\",\n \"end_time\": \"<integer>\",\n \"next_page\": \"<string>\",\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\": \"high\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"aliquad0\": false\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 \"elit2f\": -86657295.30733354\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\": \"high\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"minim_01\": \"minim tempor\",\n \"ipsum8c2\": false\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"open\",\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 \"nostrud_ee\": \"dolore veniam consequat\"\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n }\n ]\n}"
}
]
}
