Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions83

Overview

This node integrates with the Commanders Act API to retrieve various data and perform management operations across multiple resources. Specifically, for the Segment resource with the Get Segments Statistics operation, it fetches statistical data related to segments from the Commanders Act platform.

This functionality is useful when you want to analyze segment performance or usage statistics within your marketing or analytics workflows. For example, you might use this node to pull segment statistics periodically to monitor audience engagement or to feed segment data into dashboards or other systems.

Properties

Name Meaning
Query Parameters A collection of optional query parameters to customize the request. These include:
- end: End date/time for the query.
- Fields[template]: Template fields to include.
- Various filter options such as begin_date, end_date, from, to, rangeType, search, segment_id, and nested filters like sup_filters[device][] and sup_filters[location][].
- granularity: Level of detail in the statistics.
- include: Additional data to include.
- page: Pagination details.
- sort: Sorting criteria.
- source: Data source.
- start: Start date/time.
- token: An optional token for authentication or access control (password type).

The "Query Parameters" property allows fine-tuning the statistics request by specifying filters, date ranges, sorting, pagination, and other options.

Output

The output is a JSON array where each element corresponds to the response from the Commanders Act API for the requested segment statistics. The structure depends on the API's response but generally includes statistical data about segments, such as counts, metrics, or aggregated values.

If the API returns no content, the node outputs an object indicating "Status Code": "204 No Content".

No binary data output is produced by this operation.

Dependencies

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

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.
  • Required Parameter Missing: If mandatory parameters for the operation are missing, the node throws errors specifying which parameter is required. For example, if a required filter or token is missing, add it accordingly.
  • API Request Errors: Network issues, invalid query parameters, or API limits may cause errors. The node surfaces these errors with messages prefixed by "Error calling Commanders Act API". Check the message and stack trace for details.
  • Invalid JSON in Query Parameters or Request Body: Since some parameters accept JSON strings, ensure they are valid JSON to avoid parsing errors.

Links and References


This summary focuses on the Segment resource and the Get Segments Statistics operation as requested.

Discussion