分页
大多数列表端点支持通过结果进行分页的两种方法——游标分页和偏移分页。请参阅端点的API文档,以确定它支持哪些分页方法。如果未指定分页方法,则端点仅支持偏移分页。
亚博Zendesk建议尽可能使用光标分页而不是偏移分页。当检索非常大的记录集时,游标分页极大地提高了性能。看到比较游标分页和偏移分页有关分页方法之间差异的更多详细信息。
使用游标分页
要使用游标分页,请包含页面(大小)
参数中的参数。此参数还用于指定每页要返回的项数。大多数端点将此限制为最多100个。如果你省略页面(大小)
参数时,使用偏移分页。有关特定资源,请参阅API文档。
例子
例如,对带有URL的票据端点的请求https://example.亚博zendesk.com/api/v2/tickets.json?page(大小)= 100
将返回以下格式的响应:
“门票”:[…],
“元”:{
“has_more”:真正的,
“after_cursor”:“xxx”,
“before_cursor”:“多”
},
“链接”:{
“下一个”:“https://example.亚博zendesk.com/api/v2/tickets.json?page(大小)= 100和页面(后)= xxx”,
“上一页”:“https://example.亚博zendesk.com/api/v2/tickets.json?page(大小)= 100和页面(前)= yyy”
}
的值xxx
和多
是表示游标的占位符值。
中的URL链接(下)
属性检索下一页的结果。使用上面的示例,向https://example.亚博zendesk.com/api/v2/tickets.json?page(大小)= 100和页面[在]= xxx
检索下一页的结果。
在帮助中心API中,下一个
link也可以在“link”HTTP响应头中使用。例子:
链接:<https://例子。com/api/v2/help_center/在-我们/文章?页面%5粗棉布%5D=xxx&页面%5Bsize%5D=One hundred.>;rel=“下一个”
重复以上步骤,直到元(has_more)
属性是假的。这表明没有进一步的记录,您应该停止分页。
在帮助中心API中,您还可以向后分页。遵循链接(去年)
链接跳转到最后一页。那么,只要has_more
是真的,跟着上一页
每次后退一页的链接,直到has_more
是假的。就像下一个
链接时,上一页
link也可以在“link”HTTP响应头中使用。
有关更详细的说明和代码示例,请参见使用游标分页对列表进行分页。
使用偏移分页
如果您没有如上所述选择光标分页,则默认情况下将使用偏移分页。当对大容量请求使用偏移分页时,可能会有限制。看到偏移分页限制。
默认情况下,大多数列表端点每页最多返回100条记录。可以通过传递属性来更改每个请求的记录数量per_page
参数中的参数。例子:per_page = 50
。但是,在大多数端点上,每页不能超过100条记录。
当响应超过每页的最大值时,可以通过增加的方法对记录进行分页页面
参数。例子:页面= 3
。列表结果包括next_page
和previous_page
响应体中的url以便于导航:
{
“用户”:[…],
“数”:1234,
“next_page”:“https://account.亚博zendesk.com/api/v2/users.json?page=2”,
“previous_page”:零
}
停止分页,当next_page
属性是零。有关更多信息,请参见使用偏移分页对列表进行分页
由于API分页的限制,可能会在页面中引入不准确性。有关更多信息和选项,请参见API分页的限制。
一些列表可以通过传递a来排序sort_order = desc
或sort_order = asc
参数到终点。是否可以对特定列表进行排序是在该特定资源的文档中指定的。
有些端点限制页码,或者限制超过特定页码的请求。请参阅有关特定端点的文档。
偏移分页限制
使用偏移分页的请求限制为10个next_page
前1000个页面(和100,000个资源)之后每分钟的请求数。亚博电脑端
如果一个请求超过了这个限制,您将得到一个429状态码,剩下的请求将需要稍后重试。响应头将包含一个Retry-After
值,指示重试请求之前的等待时间。
其他分页方法
某些端点使用不同的分页方法: