Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions108

Overview

The "Get Live Report" operation of the Commanders Act node allows users to retrieve live reports or their data from the Commanders Act platform via its API. This is useful for obtaining real-time analytics and insights about web traffic, user behavior, or other tracked metrics managed within Commanders Act's Live Report Builder.

Typical use cases include:

  • Fetching a specific live report by its ID to analyze current performance.
  • Retrieving detailed data associated with a live report for further processing or visualization.
  • Automating report retrieval in workflows to integrate Commanders Act analytics with other systems.

For example, a marketing analyst could automate the extraction of live report data daily to feed into a dashboard or trigger alerts based on certain thresholds.

Properties

Name Meaning
Report ID The unique identifier of the live report to retrieve.
Query Parameters Optional parameters to customize the request, including:
- End: End date/time filter.
- Fields[template]: Template fields selection.
- Filter: JSON object or string to filter results (e.g., by date range, segment, device).
- Granularity: Level of detail for the report data.
- Include: Additional related data to include.
- Page: Pagination details as JSON.
- Sort: Sorting criteria, can be JSON or string depending on context.
- Source: Data source identifier.
- Start: Start date/time filter.
- Token: An optional token for authentication or access control (password type input).

Output

The node outputs an array of JSON objects representing the response from the Commanders Act API for the requested live report or live report data. The structure depends on the specific report and query parameters but generally includes:

  • Report metadata (e.g., report name, ID, creation date).
  • Metrics and dimensions as defined in the live report.
  • Filtered and aggregated data points according to the query parameters.

If the API returns no content, the output will indicate a "204 No Content" status.

The node does not output binary data for this operation.

Dependencies

  • Requires an active connection to the Commanders Act API.
  • Needs valid API credentials (an API key/token) configured in n8n to authenticate requests.
  • The base URL used is https://api.commander1.com/v2.
  • Proper permissions on the Commanders Act account to access live reports.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials. Ensure that the API key/token is correctly configured in n8n.
  • Required Parameter Missing: For this operation, the "Report ID" must be provided. Omitting it will cause an error stating that the Report ID is required.
  • API Request Errors: Network issues, invalid tokens, or insufficient permissions may result in API errors. The node surfaces these with descriptive messages including the API error message and stack trace.
  • Invalid Query Parameters: Providing malformed JSON or unsupported filters in the query parameters may cause the API to reject the request. Validate the parameters before execution.
  • Empty Response: A "204 No Content" status means the report exists but has no data matching the query parameters. Adjust filters or check report configuration.

Links and References


This summary focuses exclusively on the "Live Report Builder" resource and the "Get Live Report" operation as requested.

Discussion