PHP (Extension) / Support API / Incremental Ticket Export, Time Based
Back to Collection Items
<?php
include("chilkat_9_5_0.php");
$http->put_BasicAuth(true);$http->put_Login('login');$http->put_Password('password');$queryParams->UpdateString('start_time','<integer>');$resp->GetBodySb($sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);$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');$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');$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"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/tickets
Postman Collection Item JSON
{
"name": "Incremental Ticket Export, Time Based",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/incremental/tickets?start_time=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
"tickets"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
}
]
},
"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 time-based incremental exports.\nFor more information, see [Time-based incremental exports](/documentation/ticketing/managing-tickets/using-the-incremental-export-api#time-based-incremental-exports) in [Using the Incremental Exports API](/documentation/ticketing/managing-tickets/using-the-incremental-export-api). You can also return tickets using cursor-based pagination. See [Incremental Ticket Export, Cursor Based](#incremental-ticket-export-cursor-based).\n\nThe results include tickets that were updated by the system. See\n[Excluding system-updated tickets](/documentation/ticketing/managing-tickets/using-the-incremental-export-api#excluding-system-updated-tickets-time-based-exports) in [Using the Incremental Exports API](/documentation/ticketing/managing-tickets/using-the-incremental-export-api).\n\nThe endpoint can return tickets with an `updated_at` time that's earlier than the\n`start_time` time. The reason is that the API compares the `start_time` with the ticket's\n`generated_timestamp` value, not its `updated_at` value. The `updated_at` value is\nupdated only if the update generates a [ticket event](#incremental-ticket-event-export).\nThe `generated_timestamp` value is updated for all ticket updates, including system\nupdates. If a system update occurs after a ticket event, the unchanged\n`updated_at` time will become earlier relative to the updated `generated_timestamp`\ntime.\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?start_time=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
"tickets"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
}
]
}
},
"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}"
}
]
}
