Monocle icon

Monocle

Interact with Monocle API

Actions7

Overview

This node integrates with the Monocle API to retrieve and manipulate data related to metrics, groups, projects, and search queries within a software development analytics context. Specifically for the Group - List operation, it fetches a list of groups from a specified workspace or index.

Common scenarios where this node is useful include:

  • Retrieving all groups available in a particular workspace to analyze team structures.
  • Automating workflows that require group information for reporting or further processing.
  • Integrating group data into dashboards or other tools for monitoring collaboration metrics.

Example: You want to get all groups in your current workspace to display them in a dashboard or use them as input for another process like fetching group members or project assignments.

Properties

Name Meaning
Index Choose a workspace/index from the list or specify a string representing the workspace ID.

Note: The "Index" property uses a dynamic loading method to present available workspaces.

Output

The output JSON structure for the Group - List operation contains an array of group objects under the items field returned by the API. Each item represents a group with its associated details (the exact fields depend on the Monocle API response but typically include group identifiers, names, and metadata).

Output example structure (conceptual):

[
  {
    "id": "group1",
    "name": "Engineering Team",
    "description": "All engineers",
    ...
  },
  {
    "id": "group2",
    "name": "QA Team",
    "description": "Quality assurance",
    ...
  }
]

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Monocle API via an API key credential configured in n8n.
  • The base URL for the API is set to https://demo.changemetrics.io by default.
  • The node depends on the internal helper function to load available workspaces dynamically for the "Index" property.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying an incorrect or non-existent workspace index may result in empty results or errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • "Item not found" or similar errors suggest the provided index or group identifier does not exist; double-check inputs.
    • Timeout or network errors require checking internet connectivity and API availability.

  • To handle errors gracefully, the node supports continuing on failure, allowing partial processing of multiple items.

Links and References

Discussion