Commanders Act icon

Commanders Act

Use the Commanders Act API
Join our community

Actions108

Overview

This node integrates with the Commanders Act API, specifically providing access to various resources and operations within the platform. For the Activity Log resource with the List Activity Logs operation, it fetches detailed platform activity records intended exclusively for administrators. This is useful for auditing, monitoring user actions, or tracking system events within the Commanders Act environment.

Typical use cases include:

  • Retrieving logs of administrative activities for compliance or security reviews.
  • Monitoring changes or events in the platform over a specified time range.
  • Filtering activity logs by various parameters such as date ranges, event types, or sources.

Properties

Name Meaning
Query Parameters A collection of optional query parameters to filter and control the list of activity logs returned. These include:
- end: End date/time for filtering logs.
- Fields[template]: Template fields to include.
- filter: JSON string to specify complex filters.
- filter[begin_date], filter[end_date]: Date range filters.
- filter[from], filter[to]: Additional range filters.
- filter[rangeType]: Type of range filter applied.
- filter[search]: Search term to filter logs.
- filter[segment_id]: Filter by segment ID.
- filter[sup_filters][device][]: Filter by device(s).
- filter[sup_filters][location][]: Filter by location(s).
- filter[types]: Filter by event types.
- granularity: Level of detail or aggregation for the logs.
- include: Additional data to include in the response.
- page: JSON object specifying pagination details (e.g., page number, size).
- sort: JSON or string defining sorting order of results.
- source: Filter logs by source.
- start: Start date/time for filtering logs.
- token: An optional token parameter, treated as sensitive input (password type).

Output

The node outputs an array of JSON objects representing the activity logs retrieved from the Commanders Act API. Each item corresponds to a single activity log entry containing detailed information about platform activities.

  • The exact structure of each log entry depends on the API response but typically includes timestamps, event types, user or system identifiers, and other metadata related to the logged activity.
  • If the API returns no content, the output will indicate a "204 No Content" status.
  • The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Commanders Act API.
  • The base URL used for requests is https://api.commander1.com/v2.
  • Proper configuration of credentials in n8n is necessary to authorize API calls.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node throws an error indicating missing credentials. Ensure that a valid API authentication token is configured.
  • Required Parameter Missing: Some operations require specific IDs or parameters (e.g., Cookie ID, Alert ID). Omitting these will cause errors. Verify all required inputs are provided.
  • API Request Errors: Network issues, invalid query parameters, or API limits may cause request failures. The node surfaces these errors with descriptive messages including stack traces.
  • Parsing Errors: If the API returns malformed JSON or unexpected responses, parsing might fail. Check the API response format and adjust query parameters accordingly.
  • Empty Response: A "204 No Content" status means no data matched the query. Adjust filters or date ranges to retrieve data.

Links and References

This summary focuses on the Activity Log resource and its List Activity Logs operation as requested.

Discussion