Incremental Sample Export
GET {{baseUrl}}/api/v2/incremental/:incremental_resource/sample?start_time=<integer>
Use this endpoint to test the incremental export format. It's more strict in terms of rate limiting, at 10 requests per 20 minutes instead of 10 requests per minute. It also returns only up to 50 results per request. Otherwise, it's identical to the above APIs.
Use the incremental_resource
parameter to specify the resource. Possible values are tickets
, ticket_events
, users
, or organizations
.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
start_time | string | (Required) The time to start the incremental export from |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":2,"end_of_stream":true,"end_time":1390362485,"next_page":"https://{subdomain}.zendesk.com/api/v2/incremental/tickets.json?per_page=3\u0026start_time=1390362485","tickets":[{"assignee_id":235323,"collaborator_ids":[35334,234],"created_at":"2009-07-20T22:55:29Z","custom_fields":[{"id":27642,"value":"745"},{"id":27648,"value":"yes"}],"description":"The fire is very colorful.","due_at":null,"external_id":"ahg35h3jh","follower_ids":[35334,234],"group_id":98738,"has_incidents":false,"id":35436,"organization_id":509974,"priority":"high","problem_id":9873764,"raw_subject":"{{dc.printer_on_fire}}","recipient":"support@company.com","requester_id":20978392,"satisfaction_rating":{"comment":"Great support!","id":1234,"score":"good"},"sharing_agreement_ids":[84432],"status":"open","subject":"Help, my printer is on fire!","submitter_id":76872,"tags":["enterprise","other_tag"],"type":"incident","updated_at":"2011-05-05T10:38:52Z","url":"https://company.zendesk.com/api/v2/tickets/35436.json","via":{"channel":"web"}}]}