增加出口
使用增量导出API来获取自上次请求以来在Zendesk Support中更改或创建的项。亚博它是这样工作的:
- 下午五时请求“把今天中午以后换过的票都给我。”
- 响应“这是从中午到下午5点的改签票。”
- 晚上7点请求“把下午5点以后换的票给我。”
- 响应“这是从下午5点到7点的改签票。”
要了解更多信息，请参阅中的以下主题使用增量导出API：
速度限制
每分钟最多可以向这些端点发出10个请求。
速率限制机制的行为与中所述的机制相同速度限制．我们建议使用Retry-After头值，如中所述捕捉由速率限制引起的错误．
JSON格式
导出的项表示为JSON对象。格式取决于导出的资源和分页类型，但都有以下附加的公共属性:
| 的名字 | 类型 | 评论 |
|---|---|---|
| end_of_stream | 布尔 | 如果当前请求已经返回到当前时间的所有结果，则为True;假的,否则 |
要测试特定资源的增量导出的响应格式，可以运行一个示例导出，每个请求最多返回50个结果。看到增量样本导出．
基于指针的分页JSON格式
| 的名字 | 类型 | 评论 |
|---|---|---|
| after_url | 字符串 | URL获取结果的下一页 |
| after_cursor | 字符串 | 光标以获取结果的下一页 |
| before_url | 字符串 | URL获取结果的上一页。如果没有上一页，则该值为null |
| before_cursor | 字符串 | 光标用于获取结果的上一页。如果没有上一页，则该值为null |
基于时间的分页JSON格式
| 的名字 | 类型 | 评论 |
|---|---|---|
| end_time | 日期 | 结果集中显示的最近时间，表示为Unix纪元时间。用作start_time获取结果的下一页 |
| next_page | 字符串 | URL获取结果的下一页 |
| 数 | 整数 | 当前请求返回的结果数 |
查询字符串参数
| 的名字 | 要求 | 评论 |
|---|---|---|
| start_time | 是的 | 表示为Unix纪元时间的开始时间。看到start_time |
| 光标 | 光标只 | 游标指针。看到光标 |
| per_page | 没有 | 每页要返回的结果数目，最多可达1,000个。如果不指定该参数，默认为1000个。看到per_page |
| 包括 | 没有 | 要侧加载的资源的名称。看到包括 |
| exclude_deleted | 没有 | 是否要从响应中排除已删除的票据。看到exclude_deleted |
start_time
指定以a表示的时间Unix纪元时间．所有端点都需要astart_time参数用于初始导出。例子:
GET / api / v2 /增量/ / cursor.json票吗?start_time = 1532034771
的start_time初始导出的值是任意的。时间间隔必须大于1分钟，以免丢失数据。为了防止出现竞争条件，票务和票务事件导出端点将不会返回最近一分钟的数据。
当使用基于时间的增量导出，后续页面和导出使用start_time参数。
当使用基于指针的增量导出,start_time参数仅在初始请求中使用。后续页面和导出使用光标参数。
光标
在使用基于游标的导出时指定游标指针。的光标参数用于获取结果的下一页或进行下一次导出。的start_time参数用于获取初始导出的初始页，则光标用于后续页面和导出。
的光标参数只支持票务出口增量．
例子:
https：//{{子域名｝｝．亚博．com/api/v2/增量/票/光标．json?光标＝MTU3NjYxMzUzOS4wfHw0Njd8
看到使用游标分页在列表中进行分页欲知详情。
per_page
指定每页要返回的结果数，最多不超过1,000。默认值是1000。下面的增量导出支持per_page参数:
例子:
https：//{子域名｝．亚博．com/api/v2/增量/票．json?per_page＝One hundred.&start_time＝1332034771
如果请求很慢或开始超时，则页面大小可能太大。使用per_page参数以减少每页的结果数量。
请注意:在基于时间的导出中，如果项目共享相同的时间戳，系统可能会超过1000项默认返回限制。如果导出票据，使用基于游标的分页可以解决此问题。
包括
侧加载其他资源。亚博电脑端下面的增量导出支持包括参数:
添加一个包括指定要加载的关联的查询参数。例子:
https：//{子域名｝．亚博．com/api/v2/增量/票．json?start_time＝1332034771&包括＝metric_sets
看到侧载在核心API文档中，以及在端点文档中任何特定的旁加载信息。
请注意:last_audits由于性能原因，增量端点上不支持侧负载。
exclude_deleted
如果为true，则从响应中排除已删除的票据。默认情况下，删除将出现在票据流中。如果与增量票导出，您可以将已删除的票务活动与您的实时数据分开。
例子:
https：//{子域名｝．亚博．com/api/v2/增量/票/光标．json?exclude_deleted＝真正的&光标＝MTU3NjYxMzUzOS4wfHw0Njd8
增量票证度量事件导出
看到列出票务度量事件．
增量输出
看到NPS增量出口-响应而且NPS增量出口-收件人在NPS API文档中。
增量物品输出
看到文章列表在帮助中心API文档中。
增量票证导出，基于游标
GET / api / v2 /增量/票/光标?start_time = {start_time}
返回自开始时间以来更改的票证。有关更多信息，请参见出口的票在使用增量导出API．
此端点支持基于指针的增量导出。非常鼓励基于指针的导出，因为它们提供了更一致的性能和响应体大小。有关更多信息，请参见基于指针的增量导出在使用增量导出API．
允许
- 管理员
侧面加载
看到票拷贝的．出于性能考虑，last_audits不支持旁载。
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| 光标 | 字符串 | 查询 | 假 | 用于初始请求之后所有后续导出的游标指针 |
| start_time | 整数 | 查询 | 真正的 | 开始增量导出的时间 |
旋度
基于指针的出口
#基于指针的导出，初始请求旋度https://{子域名｝.亚博zendesk.com/api/v2/incremental/tickets/cursor.json ? start_time＝1332034771＼- v - u{email_address｝：{密码｝#基于指针的导出，后续请求旋度https://{子域名｝光亚博标.zendesk.com/api/v2/incremental/tickets/cursor.json吗?＝MTU3NjYxMzUzOS4wfHw0NTF8＼- v - u{email_address｝：{密码｝
示例响应(年代)
200好了
// Status 200 OK{“after_cursor”：“MTU3NjYxMzUzOS4wfHw0Njd8”，“after_url”：“https://{子域名}.zendes亚博k.com/api/v2/incremental/tickets/cursor.json ?光标= MTU3NjYxMzUzOS4wfHw0Njd8”，“before_cursor”：零，“before_url”：零，“end_of_stream”：真正的，“门票”：［{“assignee_id”：235323，“collaborator_ids”：［35334，234]，“created_at”：“2009 - 07 - 20 - t22:55:29z”，“custom_fields”：［{“id”：27642，“价值”：“745”｝，{“id”：27648，“价值”：“是的”｝]，“描述”：“火是五颜六色的。”，“due_at”：零，“external_id”：“ahg35h3jh”，“follower_ids”：［35334，234]，“group_id”：98738，“has_incidents”：假，“id”：35436，“organization_id”：509974，“优先”：“高”，“problem_id”：9873764，“raw_subject”：“{{dc.printer_on_fire}}”，“接收方”：”(电子邮件保护)”，“requester_id”：20978392，“satisfaction_rating”：{“评论”：“伟大的支持!”，“id”：1234，“分数”：“好”｝，“sharing_agreement_ids”：［84432]，“状态”：“开放”，“主题”：“救命，我的打印机着火了!”，“submitter_id”：76872，“标签”：［“企业”，“other_tag”]，“类型”：“事件”，“updated_at”：“2011 - 05 - 05 - t10:38:52z”，“url”：“https://company.亚博zendesk.com/api/v2/tickets/35436.json”，“通过”：{“通道”：“网络”｝｝]｝
增量票导出，基于时间
拿到票/ api / v2 /增量/吗?start_time = {start_time}
返回自开始时间以来更改的票证。有关更多信息，请参见出口的票在使用增量导出API．
此端点支持基于时间的增量导出。有关更多信息，请参见基于时间的增量导出在使用增量导出API．您还可以使用基于游标的分页来退票。看到增量票证导出，基于游标．
结果包括系统更新的票证。看到不包括系统更新的票据在使用增量导出API．
端点可以返回带有updated_at时间早于start_time时间。原因是API比较start_time带着票generated_timestamp值，而不是它的updated_at价值。的updated_at值仅在更新生成票事件．的generated_timestamp值为所有票证更新更新，包括系统更新。如果系统更新发生在票据事件之后，则不变updated_at时间相对于更新的时间会变得更早generated_timestamp时间。
允许
- 管理员
侧面加载
看到票拷贝的．出于性能考虑，last_audits不支持旁载。
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| start_time | 整数 | 查询 | 真正的 | 开始增量导出的时间 |
旋度
基于时间的出口
旋度https://{子域名｝.亚博zendesk.com/api/v2/incremental/tickets.json ? start_time＝1332034771＼- v - u{email_address｝：{密码｝
示例响应(年代)
200好了
// Status 200 OK{“数”：2，“end_of_stream”：真正的，“end_time”：1390362485，“next_page”：“https://{子域名}.zendes亚博k.com/api/v2/incremental/tickets.json ? per_page = 3 &start_time = 1390362485”，“门票”：［{“assignee_id”：235323，“collaborator_ids”：［35334，234]，“created_at”：“2009 - 07 - 20 - t22:55:29z”，“custom_fields”：［{“id”：27642，“价值”：“745”｝，{“id”：27648，“价值”：“是的”｝]，“描述”：“火是五颜六色的。”，“due_at”：零，“external_id”：“ahg35h3jh”，“follower_ids”：［35334，234]，“group_id”：98738，“has_incidents”：假，“id”：35436，“organization_id”：509974，“优先”：“高”，“problem_id”：9873764，“raw_subject”：“{{dc.printer_on_fire}}”，“接收方”：”(电子邮件保护)”，“requester_id”：20978392，“satisfaction_rating”：{“评论”：“伟大的支持!”，“id”：1234，“分数”：“好”｝，“sharing_agreement_ids”：［84432]，“状态”：“开放”，“主题”：“救命，我的打印机着火了!”，“submitter_id”：76872，“标签”：［“企业”，“other_tag”]，“类型”：“事件”，“updated_at”：“2011 - 05 - 05 - t10:38:52z”，“url”：“https://company.亚博zendesk.com/api/v2/tickets/35436.json”，“通过”：{“通道”：“网络”｝｝]｝
增量票证事件导出
GET / api / v2 /增量/ ticket_events吗?start_time = {start_time}
返回票上发生的更改流。每个事件都绑定到票据上的更新，并包含在该更改中更新的所有字段。有关更多信息，请参见:
属性可以在事件流中包含注释comment_events拷贝的。参见下面的旁载。如果您没有指定附带负载，则票据更新中出现的任何注释都仅用布尔值描述comment_present而且comment_public事件中的对象属性child_events数组中。注释本身不包括在内。
允许
- 管理员
侧面加载
端点支持comment_events拷贝的。在票据更新中出现的任何注释都被列为事件的对象child_events数组中。例子:
“child_events”：［{“id”：91048994488，“通过”：{“通道”：“api”，“源”：{“从”：{｝，”到“：{｝，“rel”：零｝｝，“via_reference_id”：零，“类型”：“评论”，“author_id”：5031726587，“身体”：“这是一个评论”，“html_body”：“& lt; div class = "zd-评论“在& lt; p dir =”汽车“这是一个评论</p>”，“公共”：真正的，“附件”：［]，“audit_id”：91048994468，“created_at”：“2009 - 06 - 25 t10:15:18z”，“event_type”：“评论”｝，.．.]，.．.
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| start_time | 整数 | 查询 | 真正的 | 开始增量导出的时间 |
旋度
旋度https://{子域名｝.亚博zendesk.com/api/v2/incremental/ticket_events.json ? start_time＝1332034771＼- v - u{email_address｝：{密码｝
示例响应(年代)
200好了
// Status 200 OK{“数”：1，“end_of_stream”：真正的，“end_time”：1601357503，“next_page”：“https://example.亚博zendesk.com/api/v2/incremental/ticket_events.json?start_time=1601357503”，“ticket_events”：［{“id”：926256957613，“即instance_id”：1，“指标”：“agent_work_time”，“ticket_id”：155，“时间”：“2020 - 10 - 26 t12:53:12z”，“类型”：“测量”｝]｝
增量用户导出，基于游标
GET / api / v2 /增量/用户/光标?start_time = {start_time}
允许
- 管理员
侧面加载
看到用户拷贝的．
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| 光标 | 字符串 | 查询 | 假 | 用于初始请求之后所有后续导出的游标指针 |
| start_time | 整数 | 查询 | 真正的 | 开始增量导出的时间 |
旋度
基于指针的出口
#基于指针的导出，初始请求旋度https://{子域名｝.亚博zendesk.com/api/v2/incremental/users/cursor.json ? start_time＝1332034771＼- v - u{email_address｝：{密码｝#基于指针的导出，后续请求旋度https://{子域名｝光亚博标.zendesk.com/api/v2/incremental/users/cursor.json吗?＝MTU3NjYxMzUzOS4wfHw0NTF8＼- v - u{email_address｝：{密码｝
示例响应(年代)
200好了
// Status 200 OK{“after_cursor”：“MTU3NjYxMzUzOS4wfHw0Njd8”，“after_url”：“https://{子域名}.zendes亚博k.com/api/v2/incremental/users/cursor.json ?光标= MTU3NjYxMzUzOS4wfHw0Njd8”，“before_cursor”：零，“before_url”：零，“end_of_stream”：真正的，“用户”：［{“活跃”：真正的，“别名”：“约翰尼先生”，“created_at”：“2009 - 07 - 20 - t22:55:29z”，“custom_role_id”：9373643，“细节”：”“，“电子邮件”：”(电子邮件保护)”，“external_id”：“sai989sur98w9”，“id”：35436，“last_login_at”：“2011 - 05 - 05 - t10:38:52z”，“场所”：“en - us”，“locale_id”：1，“主持人”：真正的，“名称”：“约翰尼代理”，“笔记”：“约翰尼是个好人!”，“only_private_comments”：假，“organization_id”：57542，“电话”：“+ 15551234567”，“照片”：{“content_type”：“图像/ png”，“content_url”：“https://company.亚博zendesk.com/photos/my_funny_profile_pic.png”，“id”：928374，“名称”：“my_funny_profile_pic.png”，“大小”：166144，“缩略图”：［{“content_type”：“图像/ png”，“content_url”：“https://company.亚博zendesk.com/photos/my_funny_profile_pic_thumb.png”，“id”：928375，“名称”：“my_funny_profile_pic_thumb.png”，“大小”：58298｝]｝，“restricted_agent”：真正的，“角色”：“代理”，“role_type”：0，“共享”：假，“shared_agent”：假，“签名”：“祝你今天愉快，约翰尼”，“暂停”：真正的，“标签”：［“企业”，“other_tag”]，“ticket_restriction”：“分配”，“time_zone”：“哥本哈根会议”，“updated_at”：“2011 - 05 - 05 - t10:38:52z”，“url”：“https://company.亚博zendesk.com/api/v2/users/35436.json”，“user_fields”：{“user_date”：“2012 - 07 - 23 t00:00:00z”，“user_decimal”：5.1，“user_dropdown”：“option_1”｝，“验证”：真正的｝]｝
增量用户导出，基于时间
GET / api / v2 /增量/用户?start_time = {start_time}
允许
- 管理员
侧面加载
看到用户拷贝的．
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| start_time | 整数 | 查询 | 真正的 | 开始增量导出的时间 |
旋度
基于时间的出口
旋度https://{子域名｝.亚博zendesk.com/api/v2/incremental/users.json ? start_time＝1332034771＼- v - u{email_address｝：{密码｝
示例响应(年代)
200好了
// Status 200 OK{“数”：1，“end_of_stream”：真正的，“end_time”：1601357503，“next_page”：“https://example.亚博zendesk.com/api/v2/incremental/ticket_events.json?start_time=1601357503”，“用户”：［{“活跃”：真正的，“别名”：“约翰尼先生”，“created_at”：“2009 - 07 - 20 - t22:55:29z”，“custom_role_id”：9373643，“细节”：”“，“电子邮件”：”(电子邮件保护)”，“external_id”：“sai989sur98w9”，“id”：35436，“last_login_at”：“2011 - 05 - 05 - t10:38:52z”，“场所”：“en - us”，“locale_id”：1，“主持人”：真正的，“名称”：“约翰尼代理”，“笔记”：“约翰尼是个好人!”，“only_private_comments”：假，“organization_id”：57542，“电话”：“+ 15551234567”，“照片”：{“content_type”：“图像/ png”，“content_url”：“https://company.亚博zendesk.com/photos/my_funny_profile_pic.png”，“id”：928374，“名称”：“my_funny_profile_pic.png”，“大小”：166144，“缩略图”：［{“content_type”：“图像/ png”，“content_url”：“https://company.亚博zendesk.com/photos/my_funny_profile_pic_thumb.png”，“id”：928375，“名称”：“my_funny_profile_pic_thumb.png”，“大小”：58298｝]｝，“restricted_agent”：真正的，“角色”：“代理”，“role_type”：0，“共享”：假，“shared_agent”：假，“签名”：“祝你今天愉快，约翰尼”，“暂停”：真正的，“标签”：［“企业”，“other_tag”]，“ticket_restriction”：“分配”，“time_zone”：“哥本哈根会议”，“updated_at”：“2011 - 05 - 05 - t10:38:52z”，“url”：“https://company.亚博zendesk.com/api/v2/users/35436.json”，“user_fields”：{“user_date”：“2012 - 07 - 23 t00:00:00z”，“user_decimal”：5.1，“user_dropdown”：“option_1”｝，“验证”：真正的｝]｝
增量组织导出
GET / api / v2 /增量/组织?start_time = {start_time}
允许
- 管理员
侧面加载
看到组织拷贝的．
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| start_time | 整数 | 查询 | 真正的 | 开始增量导出的时间 |
旋度
旋度https://{子域名｝.亚博zendesk.com/api/v2/incremental/organizations.json ? start_time＝1332034771＼- v - u{email_address｝：{密码｝
示例响应(年代)
200好了
// Status 200 OK{“数”：1，“end_of_stream”：真正的，“end_time”：1601357503，“next_page”：“https://example.亚博zendesk.com/api/v2/incremental/ticket_events.json?start_time=1601357503”，“组织”：［{“created_at”：“2018 - 11 - 14 - t00:14:52z”，“细节”：“卡特彼勒=)”，“domain_names”：［“remain.com”]，“external_id”：“ABC198”，“group_id”：1835962，“id”：4112492，“名称”：“Groablet企业”，“笔记”：“驴”，“organization_fields”：{“datepudding”：“2018 - 11 - 04 - t00:00:00 + 00:00”，“org_field_1”：“幸福快乐”，“org_field_2”：“teapot_kettle”｝，“shared_comments”：假，“shared_tickets”：假，“标签”：［“笑脸”，“teapot_kettle”]，“updated_at”：“2018 - 11 - 14 - t00:54:22z”，“url”：“https://example.亚博zendesk.com/api/v2/organizations/4112492.json”｝]｝
增量样本导出
GET / api / v2 /增量/ {incremental_resource} /样品吗?start_time = {start_time}
使用此端点测试增量导出格式。它在速率限制方面更严格，每20分钟10个请求，而不是每分钟10个请求。每个请求最多只能返回50个结果。否则，它与上面的api相同。
使用incremental_resource参数指定资源。取值为tickets、ticket_events、users或organizations。
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| start_time | 整数 | 查询 | 真正的 | 开始增量导出的时间 |
| incremental_resource | 字符串 | 路径 | 真正的 | 增量样例导出请求的资源 |
旋度
旋度https://{子域名｝.亚博zendesk.com/api/v2/incremental/{incremental_resource｝/ sample.json吗?start_time＝{unix_time｝＼- v - u{email_address｝：{密码｝
示例响应(年代)
200好了
// Status 200 OK{“数”：2，“end_of_stream”：真正的，“end_time”：1390362485，“next_page”：“https://{子域名}.zendes亚博k.com/api/v2/incremental/tickets.json ? per_page = 3 &start_time = 1390362485”，“门票”：［{“assignee_id”：235323，“collaborator_ids”：［35334，234]，“created_at”：“2009 - 07 - 20 - t22:55:29z”，“custom_fields”：［{“id”：27642，“价值”：“745”｝，{“id”：27648，“价值”：“是的”｝]，“描述”：“火是五颜六色的。”，“due_at”：零，“external_id”：“ahg35h3jh”，“follower_ids”：［35334，234]，“group_id”：98738，“has_incidents”：假，“id”：35436，“organization_id”：509974，“优先”：“高”，“problem_id”：9873764，“raw_subject”：“{{dc.printer_on_fire}}”，“接收方”：”(电子邮件保护)”，“requester_id”：20978392，“satisfaction_rating”：{“评论”：“伟大的支持!”，“id”：1234，“分数”：“好”｝，“sharing_agreement_ids”：［84432]，“状态”：“开放”，“主题”：“救命，我的打印机着火了!”，“submitter_id”：76872，“标签”：［“企业”，“other_tag”]，“类型”：“事件”，“updated_at”：“2011 - 05 - 05 - t10:38:52z”，“url”：“https://company.亚博zendesk.com/api/v2/tickets/35436.json”，“通过”：{“通道”：“网络”｝｝]｝