activity (with filters)

Use this method to retrieve information about activities in the account and filter them by activity types, dates, user IDs, space IDs, and artifact IDs. The user's permissions in the account define restrictions on the information that is returned.

Note: API documentation migrated to IBM API Hub External link opens a new window or tab. Find the latest updates and documentation for Blueworks Live APIs in API Hub.

Method summary

HTTP Method Path Description
GET /bwl/activities Retrieves information about activities in the account.

GET /bwl/activities

Description
Use this method to retrieve information about activities in the account and filter them by activity types, dates, user IDs, space IDs, and artifact IDs. The user's permissions in the account define restrictions on the information that is returned.
Resource information
Requirements Description
Response format JSON
Requires authentication Yes. The user must be an account administrator.
Supports OAuth 2 client credentials Yes, using a User Service ID containing Account Activity Category
Rate limited Blueworks Live applies a rate limit that determines how often this API can be called within a specific period. The allowed rate is 200 requests per hour.

The rate limit is applied to the whole account. Even if different authentication methods are used, the single account-wide rate is applied across all users.

When the rate limit for the API is exceeded for the account, the next request is rejected with status code 429 and response header Retry-After, which indicates the number of seconds when the next request can be made.
Parameters
Name Location Description Required Type
end_date Query The end date of the account activities to return. The date must be in ISO 8601 format (example: 2013-04-01T08:00:00.000-06:00). The endDate value must be after the startDate value. No String
start_date Query The start date of the account activities to return. The date must be in ISO 8601 format (example: 2013-04-01T08:00:00.000-06:00). No String
activity_types Query Specify one or more types of account activity to return. Any combination of types can be specified as comma-separated values. Valid values are LOGINS, PROCESSES_VIEWED, POLICIES_VIEWED, DECISIONS_VIEWED, SPACES_VIEWED, ITEMS_VIEWED, PROCESS_COMMENTS, DECISION_COMMENTS, COMMENTS, USERS_JOINED, PROCESSES_CHANGED, POLICIES_CHANGED, DECISIONS_CHANGED, SPACES_CHANGED, ACCOUNT_CHANGED, ITEMS_CHANGED, PROCESS_SNAPSHOTS, POLICY_SNAPSHOTS, DECISION_SNAPSHOTS, SNAPSHOTS.

Some types are logical groupings of other types so they can return collections of similar data:

  • ITEMS_VIEWED includes PROCESSES_VIEWED, POLICIES_VIEWED, DECISIONS_VIEWED, SPACES_VIEWED
  • COMMENTS includes PROCESS_COMMENTS, DECISION_COMMENTS
  • ITEMS_CHANGED includes PROCESSES_CHANGED, POLICIES_CHANGED, DECISIONS_CHANGED, SPACES_CHANGED
  • SNAPSHOTS includes PROCESS_SNAPSHOTS, POLICY_SNAPSHOTS, DECISION_SNAPSHOTS
 No String
users_ids Query The user IDs that you want to filter by. No String
spaces_ids Query The spaces IDs that you want to filter by. No String
artifacts_ids Query The artifacts IDs that you want to filter by. No String
include_nested_spaces Query If true, activities from nested sub spaces of the provided spaces_ids are also included. If false, only activities from the specified spaces_ids are returned. No Boolean
page_size Query The number of results per page. It can have any value between 1 and 100. No Number
cursor Query The cursor for the next page. No String
Response
The results are returned as JSON data containing an array that is mapped by the key 'records'. Each item in the array corresponds to an account activity that meets the criteria for the requested types and dates.
Example input - Get process changes by a specific user
Using OAuth 2 client credentials:
curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/bwl/activities?
activity_types=PROCESSES_CHANGED&user_ids=5f500e6250003"
Example output
{
 "records": [
  {
      "timeStamp": "2026-02-27T06:45:43.323-05:00",
      "spaceName": "SPACE-TEST",
      "itemId": "5f6000d6d43f4",
      "spaceId": "5f6000d6d43e3",
      "processName": "PROCESS",
      "property": "PROCESS_DIAGRAM",
      "type": "PROCESS_PROPERTY_CHANGED",
      "message": "created a Process Diagram in PROCESS process",
      "user": "user@mail.com"
    },
    {
      "timeStamp": "2026-02-27T06:45:31.799-05:00",
      "spaceName": "SPACE-TEST",
      "itemId": "5f6000d6d43f4",
      "spaceId": "5f6000d6d43e3",
      "isCopied": "false",
      "processName": "PROCESS",
      "type": "PROCESS_CREATED",
      "message": "created PROCESS process in SPACE-TEST space",
      "user": "user@mail.com"
    }
 ]
}
Example input - Get all item viewed (expanded type) with cursor
Using OAuth 2 client credentials:
curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/bwl/activities?
activity_types=ITEMS_VIEWED&page_size=2&cursor=eyJsYXN0X2FjdGl2aXR5X2lkIjoxNj
c3ODU0OTcwMzQ3NTU2LCJ0aW1lc3RhbXAiOiIyMDI2LTAzLTEyVDEzOjE4OjAyWiJ9"
Example output
{
  "cursor": "eyJsYXN0X2FjdGl2aXR5X2lkIjoxNjc3ODU0OTcwMzQ3NTIxLCJ0aW1lc3RhbXAiOiIyMDI2LTAzLTEyVDEzOjAzOjU1WiJ9",
  "records": [
    {
      "timeStamp": "2026-03-12T08:07:26.911-05:00",
      "spaceName": "SPACE-TEST",
      "itemId": "5f6000d6d43e3",
      "licenseType": "EDITOR",
      "spaceId": "5f6000d6d43e3",
      "itemType": "space",
      "itemName": "SPACE-TEST",
      "subType": "exited",
      "time": "Mar 12, 2026 8:07 AM",
      "type": "ITEM_VIEWED",
      "message": "user user1@mailinator.com stopped viewing space SPACE-TEST at Mar 12, 2026 8:07 AM",
      "user": "user1@mailinator.com"
    },
    {
      "timeStamp": "2026-03-12T08:03:55.834-05:00",
      "spaceName": "SPACE-TEST",
      "itemId": "5f6000d6d43e3",
      "licenseType": "EDITOR",
      "spaceId": "5f6000d6d43e3",
      "itemType": "space",
      "itemName": "SPACE-TEST",
      "subType": "entered",
      "time": "Mar 12, 2026 8:03 AM",
      "type": "ITEM_VIEWED",
      "message": "user user1@mailinator.com began viewing space SPACE-TEST at Mar 12, 2026 8:03 AM",
      "user": "user1@mailinator.com"
    }
  ]
}
Example input - Get activities in a specific space, including nested activities
Using OAuth 2 client credentials:
curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/bwl/activities?
space_ids=5f6000d6d43e3&artifact_ids=5f6000d6d6957,5f6000d6d692a&include_nest
ed_spaces=true&page_size=5"
Example output
{
  "cursor": "eyJsYXN0X2FjdGl2aXR5X2lkIjoxNjc3ODU0OTY5MjYwMzY5LCJ0aW1lc3RhbXAiOiIyMDI2LTAyLTI3VDExOjQ2OjU1WiJ9",
  "records": [
    {
      "timeStamp": "2026-02-27T06:47:39.128-05:00",
      "spaceName": "SUBSPACE-TEST",
      "itemId": "5f6000d6d6957",
      "licenseType": "EDITOR",
      "spaceId": "5f6000d6d43ec",
      "itemType": "process",
      "itemName": "SUBSPACE_PROCESS",
      "subType": "exited",
      "time": "Feb 27, 2026 5:47 AM",
      "type": "ITEM_VIEWED",
      "message": "user user2@mailinator.com stopped viewing process SUBSPACE_PROCESS in space SUBSPACE-TEST at Feb 27, 2026 5:47 AM",
      "user": "user2@mailinator.com"
    },
    {
      "timeStamp": "2026-02-27T06:47:26.422-05:00",
      "spaceName": "SUBSPACE-TEST",
      "itemId": "5f6000d6d6957",
      "spaceId": "5f6000d6d43ec",
      "processName": "SUBSPACE_PROCESS",
      "property": "PROCESS_DIAGRAM",
      "type": "PROCESS_PROPERTY_CHANGED",
      "message": "created a Process Diagram in SUBSPACE_PROCESS process",
      "user": "user2@mailinator.com"
    },
    {
      "timeStamp": "2026-02-27T06:47:20.666-05:00",
      "spaceName": "SUBSPACE-TEST",
      "itemId": "5f6000d6d6957",
      "licenseType": "EDITOR",
      "spaceId": "5f6000d6d43ec",
      "itemType": "process",
      "itemName": "SUBSPACE_PROCESS",
      "subType": "entered",
      "time": "Feb 27, 2026 5:47 AM",
      "type": "ITEM_VIEWED",
      "message": "user user2@mailinator.com began viewing process SUBSPACE_PROCESS in space SUBSPACE-TEST at Feb 27, 2026 5:47 AM",
      "user": "user2@mailinator.com"
    },
    {
      "timeStamp": "2026-02-27T06:47:19.936-05:00",
      "spaceName": "SUBSPACE-TEST",
      "itemId": "5f6000d6d6957",
      "spaceId": "5f6000d6d43ec",
      "isCopied": "false",
      "processName": "SUBSPACE_PROCESS",
      "type": "PROCESS_CREATED",
      "message": "created SUBSPACE_PROCESS process in SUBSPACE-TEST space",
      "user": "user2@mailinator.com"
    },
    {
      "timeStamp": "2026-02-27T06:46:55.546-05:00",
      "spaceName": "SUBSPACE-TEST",
      "itemId": "5f6000d6d692a",
      "licenseType": "EDITOR",
      "spaceId": "5f6000d6d43ec",
      "itemType": "process",
      "itemName": "SUBSPACE_PROCESS_APP",
      "subType": "exited",
      "time": "Feb 27, 2026 5:46 AM",
      "type": "ITEM_VIEWED",
      "message": "user user@mail.com stopped viewing process SUBSPACE_PROCESS_APP in space SUBSPACE-TEST at Feb 27, 2026 5:46 AM",
      "user": "user2@mailinator.com"
    }
  ]
}
Example input - Get all user logins
Using OAuth 2 client credentials:
curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/bwl/activities?
activity_types=LOGINS&page_size=2"
Example output
{
  "cursor": "eyJsYXN0X2xvZ2luX2lkIjo5OTIxLCJ0aW1lc3RhbXAiOiIyMDI2LTAzLTE3VDA1OjIyOjQ5WiJ9",
  "records": [
    {
      "timeStamp": "2026-03-19T02:39:17.430-05:00",
      "time": "2026-03-19T02:39:17.431-05:00",
      "type": "USER_LOGIN",
      "message": "user user@mail.com opened a login session at 2026-03-19T02:39:17.431-05:00",
      "user": "user@mail.com"
    },
    {
      "timeStamp": "2026-03-17T00:22:49.477-05:00",
      "time": "2026-03-17T00:22:49.477-05:00",
      "endTime": "2026-03-17T02:54:52.430-05:00",
      "type": "SESSION_TIMEOUT",
      "message": "user user@mail.com opened a login session at 2026-03-17T00:22:49.477-05:00 and it was closed at 2026-03-17T02:54:52.430-05:00",
      "user": "user@mail.com"
    }
  ]
}
Example input - Get all snapshots and comments for a specific process
Using OAuth 2 client credentials:
curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/bwl/activities?
activity_types=SNAPSHOTS,COMMENTS&artifact_ids=5f6000d6d43f4"
Example output
{
  "records": [
    {
      "timeStamp": "2026-03-19T03:09:12.244-05:00",
      "spaceName": "SPACE-TEST",
      "itemId": "5f6000d6d6a02",
      "spaceId": "5f6000d6d43e3",
      "itemType": "PROCESS",
      "processName": "PROCESS",
      "activityName": "Activity",
      "type": "PROCESS_COMMENT_ADDED",
      "message": "added a comment to Activity activity in PROCESS process",
      "activityType": "activity",
      "user": "user@mail.com",
      "isReply": "false"
    },
    {
      "timeStamp": "2026-03-19T03:09:00.095-05:00",
      "spaceName": "SPACE-TEST",
      "itemId": "5f6000d6d43f4",
      "spaceId": "5f6000d6d43e3",
      "processName": "PROCESS",
      "snapshotName": "Snapshot1",
      "type": "PROCESS_SNAPSHOT_TAKEN",
      "message": "created Snapshot1 snapshot of PROCESS process in SPACE-TEST space",
      "user": "user@mail.com"
    }
  ]
}
Response properties
message
A brief description of an activity that took place.
time
The date and time when the operation took place.
timeStamp
The date and time when the operation took place.
endTime
The date and time when the operation took place.
type
The type of change.
user
The user's full name.
itemId
The ID of the item associated with the artifact.
activityName
The name of activity item to which the record applied when the action occurred.
activityType
The major type of activity to which the record applied when the action occurred.
copiedFromProcessName
The link to process that it was copied from.
invitedByUserName
The full name of the user who sent the invite.
invitedUserName
The full name of the invited user.
newGoalName
The new name of the project goal.
newLaneName
The new name of the swim lane.
newParentActivityName
The name of the new parent of an activity item.
newParentActivityType
The major type of the new parent of an activity item.
oldActivityType
The major type of an activity item.
oldGoalName
The old name of the project goal.
oldLaneName
The old name of the swim lane.
oldParentActivityName
The name of the old parent of an activity item.
oldParentActivityType
The major type of the old parent of an activity item.
parentActivityName
The name of the parent of an activity item.
parentGoalName
The name of the parent of a project goal.
subType
The sub-type of the record. The value might be null.
Response messages
HTTP code Reason
200

The request was completed successfully.
400

There is an error processing the request. Required parameters were missing or contained invalid values.
401

The user isn't authorized to make the request.
404 Activities with the specified parameters were not found.
405 The specified method is not allowed. Select GET method for this request.
429 The request exceeded the rate limit of the API for this account.