List organization daily tool usages
/v2/organizations/{organization_id}/tool_usages/dailyReturns daily aggregated time spent using productivity tools (apps and websites categorized by Hubstaff).
Results can be filtered by user_ids[], task_ids[], project_ids[], tool_type, and date[start]/[stop].
Requires Owner or Organization Manager role (with view others data permission).
Note: Date range limit is 14 days. Earliest date is 1 month ago.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
organization_idrequired | path | integer (int32) | |
page_start_id | query | integer (int32) | The page start ID. |
page_limit | query | integer (int32) | The default page size |
date[start]required | query | string (date) | Start date (ISO 8601) |
date[stop]required | query | string (date) | Stop date (ISO 8601, Inclusive) |
user_ids | query | array integer[] | List of user IDs |
task_ids | query | array integer[] | List of task IDs |
project_ids | query | array integer[] | List of project IDs |
tool_type | query | string | Filter by tool type (application or url) Possible values applicationurl |
include | query | array string[] | Specify related data to side load. Possible values usersprojectstasks |
Responses
200A list of daily tool usages
- daily_tool_usagesarrayarray<object>itemsobject
DailyToolUsage model
- idinteger required
Daily Tool Usage ID
- namestring required
URL site or application name
- tool_typestring required
Tool type: application or url
- datestring required
Organization date
- user_idinteger required
User ID
- project_idinteger required
Project ID
- task_idinteger
Task ID
- trackedinteger required
Total time in seconds spent on this tool
- activationsinteger
Number of times the app was brought to focus
- created_atstring required
When the record was created
- updated_atstring required
When the record was last updated
{
"daily_tool_usages": [
{
"id": 0,
"name": "string",
"tool_type": "string",
"date": "2024-01-15",
"user_id": 0,
"project_id": 0,
"task_id": 0,
"tracked": 0,
"activations": 0,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
]
}400Invalid parameters
Hubstaff_Public_V2_Entities_Error model
- codestring required
Legacy string error code for backward compatibility
- error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
- errorstring required
Human-readable error message
- detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
itemsstring
{
"code": "string",
"error_code": 0,
"error": "string",
"details": [
"string"
]
}401Unauthorized
Hubstaff_Public_V2_Entities_Error model
- codestring required
Legacy string error code for backward compatibility
- error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
- errorstring required
Human-readable error message
- detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
itemsstring
{
"code": "string",
"error_code": 0,
"error": "string",
"details": [
"string"
]
}403API access is only for organizations on an active plan
Hubstaff_Public_V2_Entities_Error model
- codestring required
Legacy string error code for backward compatibility
- error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
- errorstring required
Human-readable error message
- detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
itemsstring
{
"code": "string",
"error_code": 0,
"error": "string",
"details": [
"string"
]
}404Could not find record
Hubstaff_Public_V2_Entities_Error model
- codestring required
Legacy string error code for backward compatibility
- error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
- errorstring required
Human-readable error message
- detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
itemsstring
{
"code": "string",
"error_code": 0,
"error": "string",
"details": [
"string"
]
}429Rate limit exceeded
Hubstaff_Public_V2_Entities_Error model
- codestring required
Legacy string error code for backward compatibility
- error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
- errorstring required
Human-readable error message
- detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
itemsstring
{
"code": "string",
"error_code": 0,
"error": "string",
"details": [
"string"
]
}