AtomicBI icon

AtomicBI

Interact with Atomic BI API
Join our community

Actions16

Overview

The node interacts with the Atomic BI API to retrieve data related to various resources. Specifically, for the Playbooks resource with the Get operation, it fetches Playbook records from the Atomic BI system based on user-defined criteria such as selected fields, filters, pagination, and sorting options.

This node is beneficial when you want to integrate Atomic BI Playbook data into your workflows, enabling automation scenarios like reporting, monitoring, or triggering actions based on Playbook attributes.

Practical examples:

  • Retrieve a list of Playbooks filtered by a specific user or space.
  • Fetch only certain fields (e.g., Id, Name, Created At) to optimize data processing.
  • Paginate through large sets of Playbooks using offset and limit.
  • Sort Playbooks by creation date in descending order to get the most recent ones first.

Properties

Name Meaning
Select List of Playbook fields to retrieve. Options include Id, User Id, Space Id, Name, Instructions, Rules, Created At, Updated At, Mail, Chat, Browser, Linkedin, Objective, Bypass Agent. Leave empty to select all fields.
Filter Filters to apply to the Playbooks returned. Each filter includes: Field (selectable or custom), Operator (Equals, Like, ILike, Contains), and Value. Only Playbooks matching these filters are included.
Offset Starting offset index for the Playbooks to return. Useful for pagination.
Limit Maximum number of Playbooks to return. Maximum allowed is 1000.
Order By Field by which to order the returned Playbooks. Same field options as Select.
Order Direction Direction of ordering: Ascending or Descending.
Additional Select Advanced option to specify extra select fields as a comma-separated string, appended to the Select list.

Output

The output is an array of JSON objects representing Playbooks retrieved from Atomic BI. Each object contains the fields requested via the Select and Additional Select properties.

  • If the Limit is set to 1, the output is a single-item array containing one Playbook object.
  • Otherwise, the output is an array of Playbook objects matching the query.

No binary data is output by this node.

Example output JSON structure for one Playbook item:

{
  "id": "string",
  "userId": "string",
  "spaceId": "string",
  "name": "string",
  "instructions": "string",
  "rules": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "mail": "boolean",
  "chat": "boolean",
  "browser": "boolean",
  "linkedin": "boolean",
  "objective": "string",
  "bypassAgent": "boolean"
}

Fields present depend on the selected fields in the input properties.

Dependencies

  • Requires an API key credential for authenticating with the Atomic BI API.
  • The node uses the Atomic BI API base URL configured in credentials.
  • No other external dependencies are required.

Troubleshooting

  • Invalid operation error: If an unsupported operation or resource is specified, the node throws an error indicating invalid operation. Ensure that the Resource is set to "Playbooks" and Operation to "Get".
  • Empty results: If no Playbooks match the filter criteria, the output will be an empty array. Verify filter values and operators.
  • API authentication errors: If the API key is missing or invalid, the node will fail to connect. Check that the API key credential is correctly configured.
  • Limit and offset misuse: Setting a very high limit may cause performance issues or API rate limits. Use reasonable limits and offsets for pagination.
  • Field selection errors: Selecting non-existent or misspelled fields may result in API errors or empty data. Use the provided field options or valid custom fields.

Links and References

Discussion