FindPipelineEntries¶
在 CRM 管道中查找交易(条目):哪些公司或联系人处于哪个阶段、归谁所有、他们的收入和其他字段。按字段值(例如 Stage 为 Demo 或 Trial,Owner 为 me)、按公司或联系人名称/域名/邮箱(使用 search)或按记录 ID 筛选;按任意字段排序(Stage 按管道顺序排序)。返回每个条目的 entryId、其跟踪的记录(ID 和名称)及其已填写的字段;此外,对所有匹配项,返回每个阶段(以及每个单选字段的每个选项)的计数,以及每个数字字段(如 Revenue)的总和:可将其用于回答“有多少交易处于 Negotiation 阶段”或“整个管道的价值是多少”等问题。要查找某个公司或联系人在所有管道中的位置(“Acme 处于哪个阶段?”),请省略 pipelineId,并将其名称作为 search(或其 recordIds)传入。从 ListPipelines 获取管道 ID 和字段名称。
参数¶
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
pipelineId |
string | 否 | 来自 ListPipelines 的管道 ID。省略它以通过 search 或 recordIds 在所有管道中查找;筛选和排序需要 pipelineId。 |
filters |
ToolFieldValue[] | 否 | 仅返回字段值符合这些值的条目;所有筛选条件必须同时匹配。选项和人员精确匹配(标签忽略大小写),文本子串匹配,日期按天匹配。示例:[{"field": "Stage", "values": ["Demo", "Trial"]}, {"field": "Owner", "value": "me"}]. |
recordIds |
string[] | 否 | 仅返回跟踪这些 CRM 公司或联系人 ID 的条目。 |
search |
string | 否 | 被跟踪公司的名称或域名,或联系人的姓名或邮箱,必须包含的文本,忽略大小写(例如 "acme")。 |
sortBy |
string | 否 | 用于对条目排序的字段名称,例如 "Revenue" 或 "Stage"。空字段排在最后。 |
descending |
boolean | 否 | 将最大值、最新日期或阶段最靠后的条目排在前面。默认值为 false。 |
limit |
integer | 否 | 最多返回的条目数。默认 50;最大 200。 |
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 macro3/macro