Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions108

Overview

This node integrates with the Commanders Act API, specifically enabling interaction with the "Live Report Builder" resource to list live reports. It allows users to retrieve a list of live reports available in their Commanders Act account, optionally filtered or paginated by various query parameters.

Common scenarios include:

  • Automating the retrieval of live report metadata for further processing or analysis.
  • Integrating live report data into workflows that require up-to-date reporting information.
  • Filtering and sorting live reports based on specific criteria such as date ranges, fields, or other filters.

For example, a user might use this node to fetch all live reports created within a certain date range or matching specific search criteria, then pass that data downstream for notifications or dashboard updates.

Properties

Name Meaning
Query Parameters A collection of optional parameters to filter, sort, paginate, and customize the live reports list. Options include:
- End (string)
- Fields[template] (string)
- Filter (JSON)
- Filter[begin_date] (string)
- Filter[end_date] (string)
- Filter[from] (string)
- Filter[rangeType] (string)
- Filter[search] (string)
- Filter[segment_id] (string)
- Filter[sup_filters][device][] (string)
- Filter[sup_filters][location][] (string)
- Filter[to] (string)
- Filter[types] (string)
- Granularity (string)
- Include (string)
- Page (JSON)
- Sort (string)
- Source (string)
- Start (string)
- Token (password string)

These parameters allow fine control over which live reports are returned and how they are presented.

Output

The node outputs an array of JSON objects representing the live reports retrieved from the Commanders Act API. Each object corresponds to a live report and contains its metadata and details as provided by the API.

If the API returns no content, the node outputs a JSON object indicating "204 No Content".

The node does not output binary data.

Dependencies

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

Troubleshooting

  • Missing Credentials: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Missing: For this operation, if required parameters like the report ID were needed (not for listing), the node would throw an error. For listing live reports, no mandatory parameter is strictly required.
  • API Errors: Any errors returned by the Commanders Act API will be caught and rethrown with descriptive messages. Check the API token validity and network connectivity.
  • Empty Response: If the API returns no data, the node outputs a "204 No Content" status object.

Links and References


This summary focuses on the "Live Report Builder" resource and the "List Live Reports" operation as requested.

Discussion