时间报告
时间报告显示每个客户端、项目、任务或用户的小时数和计费信息,其中显示给定时间框架的跟踪时间。
响应包含一个对象结果
属性,该属性包含最多到的数组per_page
结果。数组中的每个条目都是一个单独的结果对象。如果没有更多可用的结果,则结果数组将为空。响应中包含了几个额外的分页属性,以简化对结果的分页。
注意:每次报告请求都需要从
而且来
在URL的查询字符串中提供的参数。提供的时间范围不能超过1年(365天)。
结果对象
属性 | 类型 | 描述 |
---|---|---|
client_id |
整数 | 与报告的小时相关联的客户端ID。只在客户端和项目报告中返回。 |
client_name |
字符串 | 与报告的小时数相关联的客户的名称。只在客户端和项目报告中返回。 |
project_id |
整数 | 与报告的小时数相关联的项目ID。只在客户端和项目报告中返回。 |
project_name |
字符串 | 与报告的工作时间相关联的项目名称。只在客户端和项目报告中返回。 |
task_id |
整数 | 与报告的小时数关联的任务ID。仅在任务报告中返回。 |
task_name |
字符串 | 与报告的小时数关联的任务名称。仅在任务报告中返回。 |
user_id |
整数 | 与报表工时相关联的用户ID。只在团队报告中返回。 |
user_name |
字符串 | 与报告的小时数相关联的用户名。只在团队报告中返回。 |
weekly_capacity |
整数 | 这个人每周可以工作的小时数,以秒为单位,以半小时为增量。例如,如果一个人的工作时间是35小时,API将返回126000秒。只在团队报告中返回。 |
avatar_url |
字符串 | 指向用户头像图像的URL。只在团队报告中返回。 |
is_contractor |
布尔 | 与所报告的小时相关联的用户的承包商状态。只在团队报告中返回。 |
total_hours |
小数 | 给定时间框架、主题(客户端、项目、任务或用户)和货币的总时间。如果时间排开启时,小时数将根据您的设置四舍五入。 |
billable_hours |
小数 | 给定时间框架、主题(客户端、项目、任务或用户)和货币的总计费小时数。如果时间排开启时,小时数将根据您的设置四舍五入。 |
货币 |
字符串 | 与此结果的跟踪时间相关联的货币代码。控件只对管理员和项目经理可见查看计费费率和金额许可。 |
billable_amount |
小数 | 以上计费小时的总计费金额。控件只对管理员和项目经理可见查看计费费率和金额许可。 |
需要的权限
如果您是管理员,您将看到该帐户的所有客户端、项目、任务和用户。管理人员将看到他们自己的跟踪时间,以及他们管理的任何项目或队友的跟踪时间。成员只能看到他们自己跟踪的时间。
客户报告
GET / v2 /报告/时间/客户
参数 | 类型 | 要求 | 描述 |
---|---|---|---|
从 |
日期 | 要求 | 只报告带有spent_date 在给定日期或之后 |
来 |
日期 | 要求 | 只报告带有spent_date 在给定日期或之前。 |
页面 |
整数 | 可选 | 在分页中使用的页码。例如,如果您提出一个列表请求并收到2000条记录,您的后续呼叫可以包括页面= 2 检索列表的下一页。(默认值:1) |
per_page |
整数 | 可选 | 每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000) |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/reports/time/clients?from=20170101&to=20171231" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"
示例响应:
{“结果”:[{“client_id”:5735776,“client_name”:“123”产业,“total_hours”:4.5,“billable_hours”:3.5,“货币”:“欧元”,“billable_amount”:350},{“client_id”:5735774,“client_name”:“ABC集团”,“total_hours”:2,“billable_hours”:2,“货币”:“美元”,“billable_amount”:200}],“per_page”:2000,“total_pages”:1,“total_entries”:2,“next_page”:零,“previous_page”:零,“页面”:1,“链接”:{“第一”:“https://api.bob客服端下载harvestapp.com/v2/reports/time/clients?from=20170101&page=1&per_page=2000&to=20171231”,“下一个”:零,“以前”:零,“最后一次”:“https://api.bob客服端下载harvestapp.com/v2/reports/time/clients?from=20170101&page=1&per_page=2000&to=20171231”}}
项目报告
GET / v2 /报告/时间/项目
参数 | 类型 | 要求 | 描述 |
---|---|---|---|
从 |
日期 | 要求 | 只报告带有spent_date 在给定日期或之后 |
来 |
日期 | 要求 | 只报告带有spent_date 在给定日期或之前。 |
页面 |
整数 | 可选 | 在分页中使用的页码。例如,如果您提出一个列表请求并收到2000条记录,您的后续呼叫可以包括页面= 2 检索列表的下一页。(默认值:1) |
per_page |
整数 | 可选 | 每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000) |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/reports/time/projects?from=20170101&to=20171231" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"
示例响应:
{“结果”:[{“project_id”:14307913,“project_name”:“[MW]营销网站”,“client_id”:5735774,“client_name”:“ABC集团”,“total_hours”:2,“billable_hours”:2,“货币”:“美元”,“billable_amount”:200},{“project_id”:14308069,“project_name”:[OS1]网上商店-第一阶段,“client_id”:5735776,“client_name”:“123”产业,“total_hours”:4,“billable_hours”:3.,“货币”:“欧元”,“billable_amount”:300},{“project_id”:14808188,“project_name”:“[TF]特别小组”,“client_id”:5735776,“client_name”:“123”产业,“total_hours”:0.5,“billable_hours”:0.5,“货币”:“欧元”,“billable_amount”:50}],“per_page”:2000,“total_pages”:1,“total_entries”:3.,“next_page”:零,“previous_page”:零,“页面”:1,“链接”:{“第一”:“https://api.bob客服端下载harvestapp.com/v2/reports/time/projects?from=20170101&page=1&per_page=2000&to=20171231”,“下一个”:零,“以前”:零,“最后一次”:“https://api.bob客服端下载harvestapp.com/v2/reports/time/projects?from=20170101&page=1&per_page=2000&to=20171231”}}
任务报告
GET / v2 /报告/时间/任务
参数 | 类型 | 要求 | 描述 |
---|---|---|---|
从 |
日期 | 要求 | 只报告带有spent_date 在给定日期或之后 |
来 |
日期 | 要求 | 只报告带有spent_date 在给定日期或之前。 |
页面 |
整数 | 可选 | 在分页中使用的页码。例如,如果您提出一个列表请求并收到2000条记录,您的后续呼叫可以包括页面= 2 检索列表的下一页。(默认值:1) |
per_page |
整数 | 可选 | 每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000) |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/reports/time/tasks?from=20170101&to=20171231" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"
示例响应:
{“结果”:[{“task_id”:8083365,“task_name”:“平面设计”,“total_hours”:2,“billable_hours”:2,“货币”:“美元”,“billable_amount”:200},{“task_id”:8083366,“task_name”:“编程”,“total_hours”:1.5,“billable_hours”:1.5,“货币”:“欧元”,“billable_amount”:150},{“task_id”:8083368,“task_name”:“项目管理”,“total_hours”:1.5,“billable_hours”:1.5,“货币”:“欧元”,“billable_amount”:150},{“task_id”:8083368,“task_name”:“项目管理”,“total_hours”:0.5,“billable_hours”:0.5,“货币”:“美元”,“billable_amount”:50},{“task_id”:8083369,“task_name”:“研究”,“total_hours”:1,“billable_hours”:0,“货币”:“欧元”,“billable_amount”:0}],“per_page”:2000,“total_pages”:1,“total_entries”:5,“next_page”:零,“previous_page”:零,“页面”:1,“链接”:{“第一”:“https://api.bob客服端下载harvestapp.com/v2/reports/time/tasks?from=20170101&page=1&per_page=2000&to=20171231”,“下一个”:零,“以前”:零,“最后一次”:“https://api.bob客服端下载harvestapp.com/v2/reports/time/tasks?from=20170101&page=1&per_page=2000&to=20171231”}}
团队报告
GET / v2 /报告/时间/团队
参数 | 类型 | 要求 | 描述 |
---|---|---|---|
从 |
日期 | 要求 | 只报告带有spent_date 在给定日期或之后 |
来 |
日期 | 要求 | 只报告带有spent_date 在给定日期或之前。 |
页面 |
整数 | 可选 | 在分页中使用的页码。例如,如果您提出一个列表请求并收到2000条记录,您的后续呼叫可以包括页面= 2 检索列表的下一页。(默认值:1) |
per_page |
整数 | 可选 | 每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000) |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/reports/time/team?from=20170101&to=20171231" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"
示例响应:
{“结果”:[{“user_id”:1795925,“user_name”:“简·史密斯”,“is_contractor”:假,“total_hours”:0.5,“billable_hours”:0.5,“货币”:“欧元”,“billable_amount”:50,“weekly_capacity”:126000,“avatar_url”:“https://cache.bob客服端下载harvestapp.com/assets/profile_images/abraj_albait_towers.png?1498516481”},{“user_id”:1782959,“user_name”:“金艾伦”,“is_contractor”:假,“total_hours”:4,“billable_hours”:3.,“货币”:“欧元”,“billable_amount”:300,“weekly_capacity”:126000,“avatar_url”:“https://cache.bob客服端下载harvestapp.com/assets/profile_images/cornell_clock_tower.png?1498515345”},{“user_id”:1782959,“user_name”:“金艾伦”,“is_contractor”:假,“total_hours”:2,“billable_hours”:2,“货币”:“美元”,“billable_amount”:200,“weekly_capacity”:126000,“avatar_url”:“https://cache.bob客服端下载harvestapp.com/assets/profile_images/allen_bradley_clock_tower.png?1498509661”}],“per_page”:2000,“total_pages”:1,“total_entries”:3.,“next_page”:零,“previous_page”:零,“页面”:1,“链接”:{“第一”:“https://api.bob客服端下载harvestapp.com/v2/reports/time/team?from=20170101&page=1&per_page=2000&to=20171231”,“下一个”:零,“以前”:零,“最后一次”:“https://api.bob客服端下载harvestapp.com/v2/reports/time/team?from=20170101&page=1&per_page=2000&to=20171231”}}