Retrieve Activities in Org

This page is no longer maintained (Mar 29, 2023). For the most current information, go to https://docs.snaplogic.com/public-apis/get-activities-org.html.

 

GET /activities/{org}

Overview

This API retrieves information about activities in the Org.

You can filter responses based on one or more of the following criteria:

  • project space

  • project

  • asset

  • asset_type

  • user

  • event_type

  • alert_state

  • is_alert

  • start

  • end

  • offset

  • limit

Prerequisites

  • Read access to the requested assets

Request

Path Parameters

Key

Description

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

org

Required. The name of the SnapLogic Org.

Query Parameters

Key

Type

Description

Key

Type

Description

filter_project_space

string

Returns activities related to a project space.

filter_project

string

Returns activities related to a project. Requires filter_project_space.

Example: filter_project_space=myProjSpace&filter_project=My%20Test%20Project

filter_asset

string

Returns activities related to the specified asset. Requires filter_project_space and filter_ project.

Example: filter_asset_type=File&filter_asset=Sales2021Dec.csv

filter_asset_type

string

Returns activities related to specific type of assets. Valid values:

  • Account

  • File

  • Org

  • Pipeline

  • Plex

Example: filter_asset_type=File

filter_user

string

Returns activities related to a user.

filter_event_type

CSV string

Returns activities of one or more event types separated by commas.

filter_alert_state

string

Returns activities that match the specified alert state. Valid values:

  • open indicates that a potential issue in the activity must be investigated.

  • closed indicates that an issue occurred in the activity and was automatically resolved.

filter_is_alert

Boolean

If true, returns activities that are alerts; otherwise, returns activities that are not alerts.

filter_snaplogic_admin_update

Boolean

If true, returns activities that were initiated by a SnapLogic process.

start

integer

Returns activities that occurred since the specified timestamp. Provide time as Unix time in milliseconds.

end

integer

Returns activities that occurred before the specified timestamp. Provide time as Unix time in milliseconds.

limit

integer

Returns no more than the specified number of results. You can use limit and offset for pagination.

Valid values: 1 through 100,000

Default: 100

offset

integer

Returns a subset of the results starting at this 0-based index. You can use limit and offset for pagination.

Default: 0

Request Header

Specify Basic for authorization and application/json for content type.

Request Body

None.

Response

Response Body

Key

Type

Description

Key

Type

Description

total

integer

The total number of results available.

offset

integer

The index of the first result returned.

limit

integer

The number of results returned.

entries

array

An array of objects containing metadata on each activity. The structure of each object depends on the event type.

Notes

The activity logs capture the following events:

  • 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

Related Links