Unusual Activities — Hubstaff API — Hubstaff Developer Portal

List unusual activities

GET/v2/organizations/{organization_id}/insights/unusual_activities

Returns a collection of unusual activities (anomalous behavior patterns) for the given organization.

Results can be filtered by user_ids[], time_slot[start]/[stop], confidence_level, and unusual_activity_type.

Note: Unusual activities can be removed automatically by the system (e.g. after silent app member merging).

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
time_slot[start]required	query	string (date-time)	Start time (ISO 8601)
time_slot[stop]required	query	string (date-time)	Stop time (ISO 8601, Exclusive)
user_ids	query	array integer[]	List of user IDs
include	query	array string[]	Specify related data to side load. Possible values`users`
include_secondary_activities	query	boolean	DEPRECATED: Does nothing, all unusual activity is shown by default
confidence_level	query	string	Filter by confidence level Possible values`highmediumlow`
unusual_activity_type	query	string	Filter by unusual activity type Possible values`consistent_persistent_activityconsistent_variable_activityunusual_high_mouse_activityunusual_high_keyboard_activitylong_period_of_single_mouse_activitylong_period_of_single_keyboard_activitybreakless_worksustained_high_focus_timeautomation_like_activitysuspicious_activity`

Responses

200A list of unusual activity

object

unusual_activitiesarray
array<object>
items
object
UnusualActivity model
- idinteger required
  Unusual activity ID
- user_idinteger required
  User ID
- typestring required
  Unusual activity type
- keyboard_active_secondsinteger required
  Keyboard active seconds
- mouse_active_secondsinteger required
  Mouse active seconds
- time_tracked_secondsinteger required
  Time tracked seconds
- overall_active_secondsinteger required
  Overall active seconds
- urlstring required
  Permalink to the unusual activity page in the Web UI
- datestring required
  Organization date
- confidence_levelstring required
  Confidence level of the unusual activity
- top_apps_in_useobject required
  Top apps in this period of time
  object
  Top apps in this period of time
- top_urls_visitedarray required
  Top URLs in this period of time
  array<string>
  Top URLs in this period of time
  items
  string
- screenshot_idsarray required
  Screenshot IDs
  array<integer>
  Screenshot IDs
  items
  integer(int64)
- suspicious_appsarray required
  Suspicious apps
  array<string>
  Suspicious apps
  items
  string
- starts_ats required
  Start of unusual activity
- ends_ats required
  End of unusual activity
- created_atstring required
  When the record was created
- updated_atstring required
  When the record was last updated

Example response

json

{
  "unusual_activities": [
    {
      "id": 0,
      "user_id": 0,
      "type": "string",
      "keyboard_active_seconds": 0,
      "mouse_active_seconds": 0,
      "time_tracked_seconds": 0,
      "overall_active_seconds": 0,
      "url": "string",
      "date": "2024-01-15",
      "confidence_level": "string",
      "top_apps_in_use": {},
      "top_urls_visited": [
        "string"
      ],
      "screenshot_ids": [
        0
      ],
      "suspicious_apps": [
        "string"
      ],
      "starts_at": null,
      "ends_at": null,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

400Invalid parameters

object

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.
items
string

Example response

json

{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}

401Unauthorized

object

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.
items
string

Example response

json

{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}

403API access is only for organizations on an active plan

object

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.
items
string

Example response

json

{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}

404Could not find record

object

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.
items
string

Example response

json

{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}

429Rate limit exceeded

object

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.
items
string

Example response

json

{
  "code": "string",
  "error_code": 0,
  "error": "string",
  "details": [
    "string"
  ]
}