Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions83

Overview

This node integrates with the Commanders Act API to fetch and manage data related to various resources within the Commanders Act platform. Specifically, for the Sources Data Quality resource with the Get Sources Data Quality operation, it retrieves statistics about event collections across one or multiple sources. This is useful for monitoring the quality and completeness of data collected from different sources in your analytics setup.

Typical use cases include:

  • Monitoring data collection health and quality metrics for marketing or analytics sources.
  • Fetching aggregated statistics to identify data gaps or issues in source event tracking.
  • Automating reports on source data quality for operational dashboards.

Properties

Name Meaning
Query Parameters A collection of optional query parameters to customize the API request. These include:
- end: End date/time filter.
- Fields[template]: Template fields selection.
- filter: JSON filter object.
- Various specific filters such as begin_date, end_date, from, rangeType, search, segment_id, device and location filters.
- granularity: Level of data aggregation.
- include: Additional data to include.
- page: Pagination details in JSON.
- sort: Sorting options (JSON or string).
- source: Source identifier.
- start: Start date/time filter.
- token: An API token (password type).

The property "Query Parameters" allows fine-tuning the data retrieval by specifying filters, sorting, pagination, and other criteria relevant to the sources data quality endpoint.

Output

The node outputs an array of JSON objects representing the response from the Commanders Act API for the requested sources data quality statistics. The structure depends on the API response but generally includes statistical data about event collections per source, such as counts, timestamps, and quality indicators.

If the API returns no content, the node outputs a status code message indicating "204 No Content".

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Commanders Act API via an API key credential.
  • The node expects valid credentials containing a site ID and an API token.
  • Network access to https://api.commander1.com/v2 is required.
  • Proper configuration of the API credentials in n8n is necessary before using this node.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure that the Commanders Act API credentials are properly set up in n8n.
  • Required Parameter Missing: Some operations require specific IDs or parameters; if these are missing, the node will throw an error indicating which parameter is required.
  • API Request Errors: Errors returned from the API are wrapped and presented with messages like "Error calling Commanders Act API". Check the API token validity, network connectivity, and parameter correctness.
  • Empty Response: A "204 No Content" status means no data matched the query parameters. Adjust filters or check source availability.
  • Invalid JSON in Query Parameters: The filter, page, and sort parameters expect JSON strings; invalid JSON will cause parsing errors.

Links and References


This summary focuses on the Sources Data Quality resource and its Get Sources Data Quality operation as requested.

Discussion