Monocle icon

Monocle

Interact with Monocle API

Actions7

Overview

This node interacts with the Monocle API to perform search operations related to authors within a specified workspace (index). Specifically, the "Search" resource with the "Author" operation allows users to search for authors based on a query string similar to what is used in the Monocle URL interface. This can be useful for retrieving author information filtered by custom queries, such as finding authors active within a certain timeframe or matching specific criteria.

Practical examples include:

  • Searching for authors who have contributed code changes in the last three weeks.
  • Filtering authors by specific attributes or activity patterns using Monocle's query syntax.

Properties

Name Meaning
Index The workspace or data index to search within. Choose from a list of available workspaces or specify a string.
Query A query string to filter authors, formatted like a Monocle URL query (e.g., from:now-3weeks).

Output

The output JSON contains an array of author objects returned by the Monocle API that match the search query. Each item in the output corresponds to one author and includes details as provided by the API under the authors field.

The node returns this data as a JSON array, suitable for further processing or integration in workflows.

Dependencies

  • Requires an active connection to the Monocle API via an API key credential configured in n8n.
  • The node uses the base URL https://demo.changemetrics.io for API requests.
  • The "Index" property depends on loading available workspaces dynamically from the Monocle environment.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect or malformed query strings may result in empty results or API errors.
    • Specifying an invalid or unavailable workspace index will lead to request failures.

  • Error messages:

    • Authentication errors typically indicate problems with the API key setup.
    • API response errors may include messages about invalid queries or indexes; verify the query syntax and workspace availability.
    • Network or connectivity issues might cause timeouts or unreachable host errors.

To resolve these:

  • Ensure the API key credential is correctly configured and has necessary permissions.
  • Validate the query string against Monocle's query language.
  • Confirm the workspace index exists and is accessible.

Links and References

Discussion