activity

Use this resource to retrieve information about activities in the account. The user's permissions in the account define restrictions on returned information.

Method summary

HTTP Method Path Description
GET /scr/api/activity Retrieves information about activities in the account.

GET /scr/api/activity

Description
Use this method to retrieve information about activities in the account. Specify the types of activities to retrieve and the time period in which they occurred. The user's permissions in the account define restrictions on returned information.
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 Not yet
Parameters
Name Location Description Required Type
endDate 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, but by not more than 31 days. Yes String
startDate 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). Yes String
type 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
 Yes 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
  • Using OAuth 2 client credentials:
    curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/activity?startDate=2014-04-01T08:00:00.000-06:00&endDate=2014-04-02T23:59:00.000-06:00&type=LOGINS"
Example output
{
  "records": [
    {
      "message": "user user_email_1@website.com opened a login session at 2014-04-01T16:58:39.184-05:00 and it was closed at 2014-04-01T17:40:47.134-05:00",
      "time": "2014-04-01T16:58:39.184-05:00",
      "timeStamp": "2014-04-01T16:58:39.184-05:00",
      "endTime": "2014-04-01T17:40:47.134-05:00",
      "type": "SESSION_TIMEOUT",
      "user": "user_email_1@website.com"
    },
    {
      "message": "user user_email_2@website.com opened a login session at 2014-04-02T13:28:37.156-05:00 and it was closed at 2014-04-02T13:28:51.567-05:00",
      "time": "2014-04-02T13:28:37.156-05:00",
      "timeStamp": "2014-04-02T13:28:37.156-05:00",
      "endTime": "2014-04-02T13:28:51.567-05:00",
      "type": "USER",
      "user": "user_email_2@website.com"
    },
    {
      "message": "user user_email_3@website.com opened a login session at 2014-04-02T14:57:40.374-05:00 and it was closed at 2014-04-02T16:01:40.676-05:00",
      "time": "2014-04-02T14:57:40.374-05:00",
      "timeStamp": "2014-04-02T14:57:40.374-05:00",
      "endTime": "2014-04-02T16:01:40.676-05:00",
      "type": "USER",
      "user": "user_email_3@website.com"
    }
  ]
}
Response properties
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.
message
A brief description of an activity that took place.
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.
timeStamp
The date and time when operation took place.
type
The type of change.
user
The user's full name.
Response messages
HTTP code Reason
200

The request was completed successfully.
400

There was 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.