Monocle icon

Monocle

Interact with Monocle API

Actions7

Overview

This node integrates with the Monocle API to retrieve and manipulate data related to software development metrics, groups, projects, and search queries. Specifically for the Project - List operation, it fetches a list of projects from a specified workspace (index). This is useful in scenarios where you want to automate the retrieval of project information for reporting, monitoring, or further processing within an n8n workflow.

Practical examples include:

  • Automatically listing all projects in a given workspace to feed into subsequent nodes for analysis.
  • Periodically syncing project lists from Monocle into other systems.
  • Triggering workflows based on the presence or attributes of projects retrieved.

Properties

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

Note: The "Index" property is used to specify which workspace's projects to list.

Output

The output JSON contains an array of project objects under the projects key returned by the Monocle API. Each item in the output corresponds to one project with its associated details as provided by the API.

Example structure of the output JSON (simplified):

[
  {
    "id": "project_id_1",
    "name": "Project Name 1",
    "description": "Description of project 1",
    ...
  },
  {
    "id": "project_id_2",
    "name": "Project Name 2",
    "description": "Description of project 2",
    ...
  }
]

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Monocle API via an API authentication token configured in the node credentials.
  • The node uses the base URL https://demo.changemetrics.io for API requests.
  • The "Index" property depends on available workspaces, which are loaded dynamically using a helper method.

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 typically indicate invalid or expired API tokens; reconfigure credentials.
    • "Item not found" or similar errors suggest the workspace index does not exist or is inaccessible.
    • Timeout or network errors require checking internet connectivity and API availability.

  • Resolution tips:

    • Verify API credentials and permissions.
    • Confirm the workspace index value is correct and accessible.
    • Use the node’s "Load Options" feature to select valid indexes.
    • Enable "Continue On Fail" to handle errors gracefully in workflows.

Links and References

Discussion