使用 Active Collab 5 API 的跨项目时间记录过滤

Question

对于观看此标签的 Active Collab 团队。

我正在处理一个使用新的 Active Collab 5 API 的项目，我在尝试运行报告时遇到了性能问题。

示例我尝试在日期范围内构建报告，目前为了实现这一目标，我需要首先运行调用以获取所有项目。

后跟这个调用的循环：

API::get('/projects/'.$id.'/time-records/filtered-by-date?' . http_build_query(['from' => $from, 'to' => $to]))

但是我们有大量的项目，除了大量的活动项目外，我们还需要过滤存档的项目以获得正确的计费报告。

现在我在 AC 处理了大约 1500 个项目。

所以我需要进行 1500 次 API 调用，这会对性能造成巨大影响。有没有一种方法可以让您按照这些思路构建一些东西。

API::get(/timerecords/filter-by-date); 

带有一个可能的传递参数，表示（全部、活动、已编译）项目状态。

请告诉我您可以做什么，或者我是否遗漏了您的文档中已经执行此操作的内容。

谢谢

Answer 1

您需要的不是一个一个一个地遍历所有项目的请求，而是一个为跨项目报告量身定制的请求。 Active Collab 5 正好有合适的 API 端点 - /reports/run。

例如，您可以使用此命令从今天跟踪的所有活动项目中查询时间记录和费用：

curl -H "X-Angie-AuthApiToken: YOUR-API-TOKEN" "http://your.activecollab.com/api/v1/reports/run?type=TrackingFilter&project_filter=active&tracked_on_filter=today"

注意路由 (/reports/run) 和查询参数：

1. type - 指定报告类型，在本例中为时间和费用跟踪报告，
2. project_filter - 指定项目过滤器。除了active，此过滤器的其他有用值是completed（用于已完成的项目）、selected_1,2,3,4（具有项目 ID 列表的选定项目）、client_1,2,3,4（用于具有给定 ID-的客户的项目） s)、category_1,2,3,4（具有给定 ID 的类别中的项目），
3. tracked_on_filter - 按跟踪记录的日期过滤。要定位特定日期，请使用 selected_date_YYYY-MM-DD，要定位日期范围，请使用 selected_range_YYYY-MM-DD:YYYY-MM-DD。
4. tracked_by_filter - 按谁跟踪时间过滤。它可以有各种值，例如anybody、logged_user、selected_1,2,3。

要仅列出时间记录，请将type_filter 设置为time（如果您只想列出费用，则设置为expenses）。