Monocle icon

Monocle

Interact with Monocle API

Actions7

Overview

This node integrates with the Monocle API to retrieve and interact with various data related to software metrics, groups, projects, and search queries. Specifically for the Metric - Info operation, it fetches detailed information about a specific metric identified by its name or ID.

Common scenarios where this node is beneficial include:

  • Retrieving metadata or descriptive details about a particular software metric tracked in Monocle.
  • Automating reporting workflows that require metric definitions or descriptions.
  • Enriching datasets with metric info before further processing or visualization.

For example, you might use this node to get detailed info on a code quality metric before deciding how to act on it in your automation workflow.

Properties

Name Meaning
Metric Name or ID Select a metric from a dynamically loaded list or specify a metric ID using an expression. This identifies which metric's info will be retrieved.

Output

The node outputs JSON data under the json field containing the detailed information of the requested metric. The structure includes an info object with all relevant metadata returned by the Monocle API for that metric.

Example output snippet (simplified):

{
  "info": {
    "id": "metric_id",
    "name": "Metric Name",
    "description": "Detailed description of the metric",
    "type": "metric type",
    ...
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Monocle API endpoint (https://demo.changemetrics.io).
  • Needs an API authentication credential configured in n8n to authorize requests to Monocle.
  • Uses internal helper functions to load available metrics dynamically for property selection.

Troubleshooting

  • Common issues:

    • Invalid or missing metric ID/name: Ensure the metric exists and is correctly specified.
    • Authentication errors: Verify that the API key or token credential is valid and has necessary permissions.
    • Network or API downtime: Check connectivity to the Monocle API endpoint.

  • Error messages:

    • Errors thrown by the node typically include context about the item index causing failure.
    • If "continue on fail" is disabled, the node execution stops on first error; enabling it allows partial success with error details included in output.

Links and References

Discussion