AtomicBI icon

AtomicBI

Interact with Atomic BI API
Join our community

Actions16

Overview

This node interacts with the Atomic BI API to retrieve user data. Specifically, the "Users" resource with the "Get" operation allows you to query and fetch user records from Atomic BI with flexible filtering, selection, ordering, and pagination options.

Common scenarios include:

  • Fetching a list of users for reporting or auditing purposes.
  • Retrieving specific user details by applying filters such as username, email, or role.
  • Exporting user data with selected fields for integration with other systems.

Practical example:

  • You want to get all users whose role is "admin", selecting only their ID, username, and email, ordered by creation date descending, limited to 100 results.

Properties

Name Meaning
Select List of user fields to return. Options: Id, Username, Name, Created At, Updated At, Email, Role, Api Key. Leave empty to select all fields.
Filter Filters to apply on users. Each filter includes: Field (standard or custom), Operator (Equals, Like, ILike, Contains), and Value. Multiple filters can be combined.
Offset Starting offset for returned users (for pagination).
Limit Maximum number of users to return (max 1000).
Order By Field to order the returned users by. Options same as Select fields.
Order Direction Direction of ordering: Ascending or Descending.
Additional Select Advanced option to specify extra select fields as comma-separated values, appended to the main selection.

Output

The output is an array of JSON objects representing user records matching the query parameters. Each object contains the selected user fields as key-value pairs.

If the limit is set to 1, the output is a single-element array containing one user object; otherwise, it returns an array of user objects.

No binary data output is produced by this node.

Example output JSON structure (fields depend on selection):

[
  {
    "id": "123",
    "username": "jdoe",
    "email": "jdoe@example.com",
    "role": "admin",
    "createdAt": "2023-01-01T12:00:00Z"
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with the Atomic BI API.
  • The node uses the Atomic BI base URL and API key from configured credentials.
  • No additional external dependencies are required beyond the Atomic BI API access.

Troubleshooting

  • Invalid operation error: If the operation parameter is not "GET" for the Users resource, the node will throw an error. Ensure the operation is correctly set.
  • Empty results: If no users match the filter criteria, the output will be an empty array. Verify filter values and field names.
  • API authentication errors: Check that the API key credential is valid and has sufficient permissions.
  • Limit and offset issues: Setting very high limits or invalid offsets may cause unexpected results or API errors. Use sensible pagination values.
  • Field selection errors: Specifying unknown or misspelled fields in Select or Additional Select may result in API errors or missing data.

Links and References

Discussion