Info |
---|
This topic might be out-of-date and is replaced by the following: |
On this Page
Table of Contents | ||||
---|---|---|---|---|
|
Paste code macro |
---|
GET /api/1/rest/public/activities/<organization>? |
...
This API retrieves details associated with the various activities performed within an organization. You can also filter responses based on one or more of the following criteria:
project
project space
asset
user
event_type
asset_type
is_alert
alert_state
start
end
offset
Parameters
Info |
---|
All parameters are optional. All parameters are empty by default, except limit (100) and offset (0). |
Sample Activity API Call Without Parameters: https://elastic.snaplogic.com/api/1/rest/public/activities/SnapLogicCertificationOrg
Name | Type | Description |
---|---|---|
end | Timestamp | Activities that occurred before specified timestamp. Timestamp is specified as Unix timestamp in milliseconds. Example: https://elastic.snaplogic.com/api/1/rest/public/activities/SnapLogicCertificationOrg?end=1529917200000 |
filter_alert_state | String | Alerts that are either in "open" or "closed" states. |
filter_asset | String | Activities related to an asset. Requires filter_project_space and filter_ project. Example: https://elastic.snaplogic.com/api/1/rest/public/activities/SnapLogicCertificationOrg?filter_asset_type=File&filter_asset=Sales2019July.csv |
filter_asset_type | String | Activities related to specific type of assets. Example: https://elastic.snaplogic.com/api/1/rest/public/activities/SnapLogicCertificationOrg?filter_asset_type=File Asset Types: File, Pipeline, Plex, Org, Account |
filter_event_type | CSV string | Activities of a one or more event types separated by comma. |
filter_is_alert | Boolean | Activities that are alerts (filter_is_alert=true) or activities that are not alerts (filter_is_alert=false). |
filter_project | String | Activities related to a project. Requires filter_project_space Example: |
https://elastic.snaplogic.com/api/1/rest/public/activities/orgname?filter_project_space=projects&filter_project=Test%20Project | ||
filter_project_space | String | Activities related to a project space. |
filter_user | String | Activities related to a user. |
limit | Number | Limit the number of results to this value. If not specified, the default value is 100. Example: https://elastic.snaplogic.com/api/1/rest/public/activities/SnapLogicCertificationOrg?limit=10 |
offset | Number | An offset to start returning activities from. If not specified, the default value is 0. Example: https://elastic.snaplogic.com/api/1/rest/public/activities/SnapLogicCertificationOrg?offset=400 |
start | Timestamp | Activities that have occurred since specified timestamp. Timestamp is specified as Unix timestamp in milliseconds. Example: https://elastic.snaplogic.com/api/1/rest/public/activities/SnapLogicCertificationOrg?start=1529917200000 |
Following is complete list of events that are captured in the activity logs:
...
Paste code macro |
---|
{ "response_map": { "total": 35007, "offset": 0, "limit": 100, "entries": [ { "event_type": "asset_create", "parent_type": "Project Space", "org_label": "automation", "create_time": "2018-07-04T06:57:04.823000+00:00", "org_snode_id": "5806521b242e3f794b90c16c", "project_snode_id": "5b3c6fc056f9a0001fd3ae06", "asset_label": "1PipelineExecutionStatsProject3", "class_version": 1, "parent_path": "/automation/projects", "template": "%(by_whom)s created the %(display_type)s %(asset_label)s under %(parent_type)s %(parent_path)s in organization %(org_label)s", "partition_label": "projects", "project_label": "1PipelineExecutionStatsProject3", "parent_label": "projects", "partition_snode_id": "5806521b242e3f794b90c173", "display_type": "Project", "asset_snode_id": "5b3c6fc056f9a0001fd3ae06", "asset_type": "Dir", "asset_path": "/automation/projects/1PipelineExecutionStatsProject3", "class_id": "com-snaplogic-auditevent", "parent_snode_id": "5806521b242e3f794b90c173", "by_whom": "autoregplatform+admin1@gmail.com", "_id": "5b3c6fc056f9a0001fd3ae07" }, ] }, "http_status_code": 200 } |
Key | Description |
---|---|
total | The number of available records. |
offset | The start point of the records (0 is the default). |
limit | The number of entries to displays in a page. |
entries | Activity even details. |