Zoho crm Logo

模块中的记录计数

目的

获取模块中的记录总数或符合条件的记录数。您还可以从模块的自定义视图中获取记录数。

  • GET /{module_api_name}/actions/count?cvid={custom_view_ID_here}
  • GET /{module_api_name}/actions/count?criteria={criterion_here}
  • GET /{module_api_name}/actions/count?email={email_here}
  • GET /{module_api_name}/actions/count?phone={phone_number_here}
  • GET /{module_api_name}/actions/count?word={search_word_here}

请求详情

请求 URL

{api-domain}/crm/{version}/{module_api_name}/actions/count

支持的模块

潜在客户,Account,联系人,交易,任务,会议,电话,产品,价格表,报价,Sales Orders,采购Orders,Invoices,活动,Vendors,案例,解决方案,服务,预约,重新安排的预约历史和自定义

标题

授权:Zoho-oauthtoken <access_token>

范围

范围 = ZohoSearch.securesearch.READ
(和)
ZohoCRM.modules.{module_name}.READ
(和)
范围=ZohoCRM.settings.layouts.READ/ALL
(或)
范围=ZohoCRM.settings.ALL

参数
  • cvid string, optional

    自定义视图的ID,用于获取记录计数。使用自定义视图元数据API来获取模块中可用的自定义视图。示例:cvid=5690xxxx980。
    请注意,不能将搜索参数与此参数结合使用;否则会导致“AMBIGUITY_DURING_PROCESSING”错误。

  • criteria string, optional

    获取符合条件的记录数量的条件。您可以根据字段的 API 名称过滤记录。支持的操作符有等于、以...开始、在...之内、不等于、大于等于、大于、小于等于、小于和介于。支持的数据类型有选择列表、id、所有者查找、用户查找、查找、电话、电子邮件、日期、日期时间、整数、货币、小数和双精度。

  • phone string, optional

    您想要检索的包含给定电话号码的记录总数,这些记录在其电话字段中包含该电话号码。
    示例:phone=9876543210。

  • email string, optional

    您想要检索的包含给定Email ID的记录总数。确保对Email ID中的任何特殊字符进行编码。
    示例:Email=p%2Bboyle@abc.com(Email p+boyle@abc.com 的编码形式)。

  • word string, optional

    您想要检索的包含给定单词的记录总数,该单词可以出现在任何字段中。
    示例:word=fin。

注意

  • 除了上述参数外,您还可以使用搜索记录页面中提到的其他可选参数。
  • 刷新统计数据会有1-10分钟的延迟。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/actions/count?cvid=554023000000430419"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

可能的错误

  • AMBIGUITY_DURING_PROCESSING HTTP 400

    原因:

    您在请求中同时指定了“cvid”和一个搜索参数,如“criteria”、“phone”、“email”或“word”。

    解决方法:请求中只能包含“cvid”或一个搜索参数。

  • INVALID_QUERYHTTP 400

    原因:

    • 您构建了一个无效的搜索查询。
    • 查询中的字段不支持该操作符。

    解决方法:请参阅响应中的“details”键。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您没有使用此 API 所需的权限范围。
    解决方法:使用正确的权限范围并生成授权和访问令牌。

示例响应

Copied{
    "count": 694
}