Activity API

On this Page

Overview

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

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

endTimestamp

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_stateString

Alerts that are either in "open" or "closed" states. 
An "open" state indicates that there could be a potential issue that should be investigated.
A "closed" state indicates that the issue has been resolved and doesn't require any action on part of the user.

filter_assetString

Activities related to an asset. Requires filter_project_space and filter_ project.

Examplehttps://elastic.snaplogic.com/api/1/rest/public/activities/SnapLogicCertificationOrg?filter_asset_type=File&filter_asset=Sales2019July.csv

filter_asset_typeString

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_typeCSV stringActivities of a one or more event types separated by comma.
filter_is_alertBooleanActivities that are alerts (filter_is_alert=true) or activities that are not alerts (filter_is_alert=false).
filter_projectString

Activities related to a project. Requires filter_project_space

Examplehttps://elastic.snaplogic.com/api/1/rest/public/activities/orgname?filter_project_space=projects&filter_project=Test%20Project

filter_project_spaceStringActivities related to a project space.
filter_userString

Activities related to a user.

limitNumber

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

offsetNumber

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:

session_start, session_end, user_create, user_delete, user_auth_failure, user_lockout, user_unlock, password_change, password_reset, asset_create, asset_update, asset_delete, asset_rename, asset_owner_change, asset_move, acl_add, acl_remove, plex_node_add, plex_node_restart, dist_change, dist_override, group_create, group_delete, group_update, plex_congestion, plex_node_enter_maintenance_mode, plex_node_leave_maintenance_mode

Typical API Call Response

A typical response map of an API Activity API call contains the following details:


KeyDescription
totalThe number of available records.
offsetThe start point of the records (0 is the default).
limitThe number of entries to displays in a page.
entriesActivity even details.

See Also