Commanders Act icon

Commanders Act

Use the Commanders Act API
Join our community

Actions108

Overview

This node integrates with the Commanders Act API, specifically supporting the "Source" resource and the "List Source Categories" operation. It allows users to retrieve a list of source categories from the Commanders Act platform. This is useful for scenarios where you want to programmatically access metadata about data sources categorized within Commanders Act, such as for reporting, analytics setup, or integration workflows.

Practical examples include:

  • Automatically fetching available source categories to populate dropdowns in other workflows.
  • Synchronizing source category data with external systems.
  • Filtering or segmenting data based on source categories in automated pipelines.

Properties

Name Meaning
Query Parameters A collection of optional parameters to customize the API request. Options include:
- End End date/time filter for the query.
- Fields[template] Template fields filter.
- Filter JSON object for complex filtering criteria.
- Filter[begin_date] Begin date filter for the query.
- Filter[end_date] End date filter for the query.
- Filter[from] From filter parameter.
- Filter[rangeType] Range type filter.
- Filter[search] Search string filter.
- Filter[segment_id] Segment ID filter.
- Filter[sup_filters][device][] Device filters (array).
- Filter[sup_filters][location][] Location filters (array).
- Filter[to] To filter parameter.
- Filter[types] Types filter.
- Granularity Granularity level for the data.
- Include Additional includes for the response.
- Page Pagination options as JSON.
- Sort Sorting options as JSON or string depending on context.
- Source Source identifier filter.
- Start Start date/time filter for the query.
- Token An API token or authentication token (password type input).

These parameters allow fine-tuning the request to the API endpoint that lists source categories.

Output

The node outputs an array of JSON objects representing the source categories retrieved from the Commanders Act API. Each item corresponds to a source category with its associated metadata as returned by the API.

If the API returns no content, the node outputs a status code message indicating "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 base URL used is https://api.commander1.com/v2.
  • The node expects the user to configure credentials containing a site ID and an API token.
  • The node uses HTTP requests with JSON payloads and Bearer token authorization.

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 source ID were needed (not in this case), the node would throw an error specifying which parameter is missing.
  • API Errors: Any errors returned by the Commanders Act API will be caught and rethrown with descriptive messages including the original error message and stack trace.
  • Invalid JSON in Query Parameters: If JSON-type query parameters are malformed, the API call may fail; ensure JSON inputs are valid.
  • Empty Response Handling: If the API returns an empty string, the node outputs a "204 No Content" status instead of failing.

Links and References

This summary focuses on the "Source" resource and the "List Source Categories" operation as requested, describing the relevant input properties, output structure, dependencies, and potential troubleshooting points.

Discussion