Actions14
Estimate → Get
AI-generatedOverview
This node interacts with the ChecklistBank API to retrieve taxonomic estimate data from a specified dataset. The "Estimate" resource with the "Get" operation allows users to fetch estimates related to taxa counts within a dataset, filtered by various criteria such as scientific name, rank, and modification details.
Typical use cases include:
- Retrieving estimated numbers of taxa at different taxonomic ranks within a dataset.
- Filtering estimates by specific scientific names or user modifications.
- Paging through large sets of estimate data using offset and limit parameters.
For example, a researcher might use this node to get an estimate of the number of species (rank: SPECIES) in a particular dataset identified by its key.
Properties
| Name | Meaning |
|---|---|
| Dataset Key | The unique identifier of the dataset to query. This is required and can be found using the Dataset Search resource. |
| Broken | Boolean flag indicating whether to filter for estimates that are marked as broken. |
| ID | The specific estimate ID to retrieve. |
| Modified By | Filter estimates by the user ID who last modified them. |
| Name | Filter estimates by a scientific name. |
| Rank | Filter estimates by taxonomic rank. Options include a comprehensive list of taxonomic ranks such as Domain, Kingdom, Phylum, Class, Order, Family, Genus, Species, Subspecies, Variety, Form, and many others. |
| Maximum Estimate | Filter by the maximum estimated number of taxa. |
| Minimum Estimate | Filter by the minimum estimated number of taxa. |
| Offset | Numeric offset for paging through results. Defaults to 0. |
| Limit | Maximum number of results to return. Must be at least 1. Defaults to 50. |
Output
The node outputs an array of JSON objects representing the retrieved estimate data from the ChecklistBank API. Each object corresponds to an estimate record containing fields such as estimate ID, associated dataset key, taxonomic rank, estimated counts, and metadata about modifications.
No binary data output is involved.
Dependencies
- Requires access to the ChecklistBank API endpoint
https://api.checklistbank.org. - No explicit API keys or authentication tokens are shown in the code; however, depending on the API's requirements, an API key credential or token may be necessary to configure in n8n.
- The node uses standard HTTP GET requests with JSON responses.
Troubleshooting
- Empty or no results: Ensure the Dataset Key is correct and that filters like Name, Rank, or IDs are valid and exist in the dataset.
- Invalid parameter values: For example, providing a non-numeric value for Offset or Limit will cause errors. Make sure numeric inputs are valid.
- API connectivity issues: Network problems or incorrect API URLs can cause request failures. Verify internet connectivity and API endpoint accessibility.
- Rate limiting or authorization errors: If the API requires authentication, missing or invalid credentials may result in errors. Configure the required API authentication in n8n.
- Large result sets: Using very high limits without offsets may lead to timeouts or performance issues. Use paging parameters appropriately.
Links and References
- ChecklistBank API Documentation (official API docs for more details on endpoints and parameters)
- Taxonomic rank definitions: The node supports a wide range of taxonomic ranks commonly used in biological classification.
If you need further details on other resources or operations, feel free to ask!