搜索

Search API是一个统一的搜索API，它返回票证、用户和组织。您可以定义过滤器，根据资源类型、日期和对象属性(如票据请求者或标记)来缩小搜索结果。

要在帮助中心搜索文章，请参见搜索在帮助中心API文档中。

要将API与Python或Perl一起使用，请参见使用Zendesk API进行搜索亚博。

请注意为新的票证、用户和其他资源建立索引以供搜索可能需要几分钟的时间。亚博电脑端如果新的资源没亚博电脑端有出现在你的搜索结果中，等几分钟再试一次。

结果限制

Search API每次查询最多返回1,000个结果，每页最多返回100个结果。看到分页。如果您请求的页面超过限制(页面= 11(每页100个结果)，则返回422“资源不足错误”。

如果需要检索大型数据集，Zendesk建议将搜索结果限制在特定的日期范围内，从而亚博将搜索分成更小的块。你也可以用导出查询结果端点。

或者，如果您只想基于最近的更改进行增量更改，请考虑使用增加出口端点。

的数属性显示结果的实际数量。例如，如果查询有5,000个结果，则数value将为5,000，即使API只返回前1,000个结果。

查询基础知识

在URL参数中指定搜索查询查询：

…/ api / v2 / search.json吗?查询= {search_string}

语法的例子

的查询语法{search_string}详情见亚博Zendesk支持搜索参考，但本节给出了一个快速概述。该语法为您提供了很大的灵活性。例子:

它是如何工作的:

• 的：字符是相等操作符。其他运营商包括<和>，负号-，以及通配符*。了解更多有关操作符的信息。

• 双引号,""，指定搜索短语。该API使用精确的单词匹配。例如，“top”的搜索结果将包括与字符串“top”匹配的单个单词，或与较长的短语(“top tier”)中的单个单词匹配的数据。它不会包含较长单词的前缀(“topology”)，或者字符串“top”出现在单词中间或末尾的数据(“stopwatch”，“desktop”)。

• 的类型属性返回指定资源类型的记录。可能的值包括票，用户，组织,或集团。看到使用'type'关键字在Ze亚博ndesk帮助。

• 的状态属性返回设置为指定状态的票据。可能的值包括新，开放，等待，持有，解决了,或关闭。看到票务属性关键词在Ze亚博ndesk帮助。还可以按用户、组织和组属性进行搜索。

• 属性，例如创建，更新,解决了可以返回特定时间、特定时间或之前以及特定时间或之后的记录。API支持ISO 8601格式的日期，如“2021-09-01 (YYYY-MM-DD)”或日期时间，如“2021-09-01T12:00:00-08:00”。看到按日期和时间搜索在Ze亚博ndesk帮助。

url编码搜索字符串

因为搜索字符串是在HTTP请求中发送的，所以字符串必须是url编码的。例子:

查询? = % 3 aticket型+ % 3 aopen地位

大多数HTTP库都提供了url编码字符串的工具。在cURL中，可以使用——data-urlencode选项。- g国旗:

             

              
旋度“https://{子域名}.zendes亚博k.com/api/v2/search.json”＼-G--数据-urlencode“查询=类型:机票状态:开放”＼-v-u{email_address｝：{密码｝
             

在Python 3中，您可以使用urlencode ()方法中的urllib.parse模块。

例如，请参见使用Zendesk API进行搜索亚博。

侧载

Search API支持侧加载，它允许您作为单个请求的一部分检索相关记录。要发出请求，请添加一个包括参数，指定要加载的关联。

例如，下面的请求搜索包含“help”的记录并指定类型票来加载票证的用户数据。

             

              
/api/v2/搜索。json？查询=帮助＆包括=票（用户）
             

有关更多信息，请参见侧载。

JSON格式

搜索被表示为具有以下属性的JSON对象:

例子

             

              
{“数”：1，“面”：零，“next_page”：零，“previous_page”：零，“结果”：［{“created_at”：“2018 - 04 - 06 - t03:17:05z”，“默认”：假，“删除”：假，“描述”：""，“id”：1835972，“名称”：“Ragtail”，“result_type”：“集团”，“updated_at”：“2018 - 04 - 06 - t03:17:05z”，“url”：“https://example.亚博zendesk.com/api/v2/groups/1835972.json”｝］｝
             

列表搜索结果

• GET / api / v2 /搜索?查询查询= {}

使用与字符(&)追加sort_by或sort_order参数到URL。

例如，请参见搜索Zendesk API亚博。

分页

• 仅偏移分页

在分页时，偏移分页可能导致重复的结果。你也可以用导出查询结果端点，它使用基于游标的分页并且不返回重复的结果。看到分页了解更多信息。

允许

• 管理员、代理和轻代理

JSON格式错误

错误表示为JSON对象，具有以下键:

错误示例

             

              
{“错误”：“不可用”，“描述”：“对不起，我们无法完成您的搜索查询。请稍后再试。”｝
             

参数

              

               
旋度“https://{子域名}.zendes亚博k.com/api/v2/search.json”＼- g - data-urlencode“查询=类型:机票状态:开放”＼- v - u{email_address｝：{密码｝
              

示例响应(年代)

              

               
//状态200 OK{“数”：1234，“面”：零，“next_page”：“https://foo.亚博zendesk.com/api/v2/search.json?query= \”类型:你好\“&sort_by = created_at&sort_order = desc&page = 2”，“previous_page”：零，“结果”：［{“created_at”：“2009 - 05 - 13 - t00:07:08z”，“id”：211，“名称”：“你好dj”，“result_type”：“集团”，“updated_at”：“2011 - 07 - 22 - t00:11:12z”，“url”：“https://foo.亚博zendesk.com/api/v2/groups/211.json”｝，{“created_at”：“2009 - 08 - 26 - t00:07:08z”，“id”：122，“名称”：“你好,MCs”，“result_type”：“集团”，“updated_at”：“2010 - 05 - 13 - t00:07:08z”，“url”：“https://foo.亚博zendesk.com/api/v2/groups/122.json”｝］｝
              

显示结果计数

• GET / api / v2 /搜索/计数?查询查询= {}

返回与查询匹配的项数，而不是项数。搜索字符串的工作方式与常规搜索相同。

参数

              

               
旋度“https://{子域名}.zendes亚博k.com/api/v2/search/count.json”＼- g - data-urlencode“查询=类型:机票状态:开放”＼- v - u{email_address｝：{密码｝
              

示例响应(年代)

              

               
//状态200 OK{“数”：6｝
              

导出查询结果

• GET / api / v2 /搜索/出口吗?查询查询= {}

导出一组结果。看到查询基础知识的语法查询参数。

此端点用于将返回1000多个结果的搜索查询。结果集仅按created_at属性。

搜索只返回单一对象类型的结果。支持以下对象类型:票据、组织、用户或组。

类型中指定类型过滤器(类型)参数。使用查询字符串中的type进行搜索将导致错误。

允许

• 代理

分页

• 光标分页

看到分页。

每页最多返回1000条记录。在页面中显示的结果数量由页面(大小)参数。

请注意如果每页请求1000个结果，并且结果中有许多存档的票证，则速度可能会降低。尽量减少每页的结果数量。

属性指定的游标after_cursor响应中的属性在一小时后到期。

有关基于游标的分页的详细信息，请参阅以下文章:

• 比较游标分页和偏移分页
• 使用游标分页对列表进行分页

限制

此API端点的速率限制为每个帐户每分钟100个请求。该限制也计入全局API速率限制。

响应格式

反应类似于GET / api / v2 / search.json吗?，做了一些改动:

• 链接-具有以下嵌套属性:上一页和下一个。这些代替了next_page和prev_page链接。的上一页属性始终为空，因为不支持向后分页。的下一个属性可能包含指向下一页结果的自动生成链接。
• 元-具有以下嵌套属性:has_more和after_cursor。的has_more属性指示下一页是否有更多结果。的after_cursor属性是用于分页到下一页的游标。一小时后过期。

没有数财产。

参数

              

               
旋度“https://{子域名}.zendes亚博k.com/api/v2/search/export.json”- g＼——data-urlencode“查询=你好'＼——data-urlencode的页面(大小)= 100＼——data-urlencode“过滤器[型]=票”＼- v - u{email_address｝：{密码｝
              

示例响应(年代)

              

               
//状态200 OK{“面”：零，“链接”：{“下一个”：“https://example.亚博zendesk.com/api/v2/search/export.json?filter%5Btype%5D=ticket&page%5Bafter%5D=eyJmaWVsZCI6ImNyZWF0ZWRfYXQiLCJkZXNjIjp0cnVlLCJ0aWVCcmVha0ZpZWxkIjoiaWQiLCJ0aWVCcmVha0Rlc2MiOmZhbHNlLCJzb3J0VmFsdWVzIjpudWxsLCJleHBvcnRlZFRodXNGYXIiOjAsInNlc3Npb25TdGFydCI6MTYwNzAzOTI1Mzk4NSwiY3JlYXRlZEF0IjoxNjA3MDM5MjUzOTg1LCJzYWx0ZWRSZXF1ZXN0SGFzaCI6LTQ5ODM0ODc3LCJzYWx0ZWRDdXJzb3JIYXNoIjotMjQwMzQ4MjgwfQ%3D%3D&page%5Bsize%5D=100&query=hello%26page%5Bsize%5D%3D100%26filter%5Btype%5D%3Dticket”，“上一页”：零｝，“元”：{“after_cursor”：“eyJmaWVsZCI6ImNyZWF0ZWRfYXQiLCJkZXNjIjp0cnVlLCJ0aWVCcmVha0ZpZWxkIjoiaWQiLCJ0aWVCcmVha0Rlc2MiOmZhbHNlLCJzb3J0VmFsdWVzIjpudWxsLCJleHBvcnRlZFRodXNGYXIiOjAsInNlc3Npb25TdGFydCI6MTYwNzAzOTI1Mzk4NSwiY3JlYXRlZEF0IjoxNjA3MDM5MjUzOTg1LCJzYWx0ZWRSZXF1ZXN0SGFzaCI6LTQ5ODM0ODc3LCJzYWx0ZWRDdXJzb3JIYXNoIjotMjQwMzQ4MjgwfQ = = "，“before_cursor”：零，“has_more”：真正的｝，“结果”：［］｝