AvantGuard - WebhookSite icon

AvantGuard - WebhookSite

AvantGuard - WebhookSite

Actions100

Overview

This node operation retrieves activity logs from a system, allowing users to query and filter logs based on various criteria such as user information, resource details, action messages, and date ranges. It is useful for auditing, monitoring user actions, troubleshooting issues, or generating reports about system activities.

Practical examples include:

  • Fetching all activity logs related to a specific user by their ID or email.
  • Retrieving logs filtered by a particular resource type and ID to track changes or access.
  • Limiting results to a certain page size and page number for paginated viewing.
  • Filtering logs starting from a specific date to analyze recent activities.

Properties

Name Meaning
Additional Query Parameters Optional filters and pagination controls including:
- Page Specify the current page of results to retrieve (number).
- User Id Filter logs by a specific user ID (number).
- User Email Filter logs by a user's email address (string).
- Resource Id Filter logs by resource ID; must be used with resource type (number).
- Resource Type Filter logs by resource type (e.g., Asset, Company, Article); must be used with resource ID (string).
- Action Message Filter logs by the action performed (string).
- Start Date Filter logs starting from a specific date in ISO 8601 format (string).
- Page Size Specify the number of results to return per page (number).

Output

The output contains a JSON object representing the retrieved activity logs matching the specified filters. Each log entry typically includes details such as the user involved, the resource affected, the action performed, timestamps, and other relevant metadata.

If the node supports binary data output, it would represent associated files or attachments related to the logs, but this is not indicated in the provided code or properties.

Dependencies

  • Requires an API key or authentication token configured in the node credentials to access the activity logs service.
  • The base URL for the API is set via credentials.
  • No additional external dependencies are indicated.

Troubleshooting

  • Empty Results: If no logs are returned, verify that the filter parameters (user ID, resource type, dates) are correct and that there are logs matching those criteria.
  • Invalid Date Format: Ensure the "Start Date" is in valid ISO 8601 format to avoid errors.
  • Pagination Issues: If specifying page or page size, confirm values are positive integers.
  • Authentication Errors: Check that the API key or authentication token is correctly configured and has sufficient permissions.
  • Missing Required Filters: When using resource_id, ensure resource_type is also provided, and vice versa, to avoid incomplete queries.

Links and References

  • ISO 8601 Date Format
  • General API usage and pagination concepts (refer to your API provider's documentation for specifics).

Discussion