AtomicBI icon

AtomicBI

Interact with Atomic BI API
Join our community

Actions16

Overview

This node interacts with the Atomic BI API to perform operations on various resources. Specifically, for the Campaigns resource and the Update operation, it allows users to update campaign data by specifying which fields to select, filter criteria, pagination options (offset and limit), and ordering preferences.

Common scenarios where this node is beneficial include:

  • Updating specific campaigns based on complex filters.
  • Retrieving updated campaign information selectively to optimize data handling.
  • Managing large sets of campaigns with pagination and sorting.

For example, a user might want to update campaigns that have a certain status or were created after a specific date, selecting only relevant fields like "Name" and "Status" to minimize data transfer.

Properties

Name Meaning
Select List of fields to select from campaigns. Leave empty to select all fields. Options include Id, Name, Description, Language, Space Id, Agent Id, Status, Created At, Updated At, Connection Id, Inbox Synced Until, Job Schedule, Fields, Filters, Orders, Presets, Completed At, Converted Title.
Filter Filters to apply when selecting campaigns. Each filter includes: Field (predefined or custom), Operator (Equals, Like, ILike, Contains), and Value. Used to narrow down which campaigns are affected or retrieved.
Offset Starting offset for the list of campaigns to return. Useful for pagination.
Limit Maximum number of campaigns to return. Maximum allowed is 1000.
Order By Field by which to order the returned campaigns. Same field options as in Select.
Order Direction Direction of ordering: Ascending or Descending.
Additional Select Advanced option to specify additional select fields as a comma-separated string.

Output

The node outputs JSON objects representing campaigns. The structure of each output JSON corresponds to the selected fields of the campaign(s) retrieved or updated. If multiple campaigns are returned, the output is an array of such JSON objects.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Atomic BI API.
  • Needs configuration of the base URL for the Atomic BI API endpoint.
  • Uses internal utility modules for building schema, filtering, and parameter parsing.

Troubleshooting

  • Invalid operation error: If an unsupported operation is specified, the node throws an error indicating the invalid resource/operation combination.
  • Empty or incorrect filters: Providing malformed filters or unsupported field names may result in no data returned or API errors.
  • Limit and offset misuse: Setting limit too high or offset beyond available data can cause empty results.
  • Authentication issues: Missing or incorrect API key credentials will prevent successful API calls.

To resolve these:

  • Verify operation and resource names are correct.
  • Double-check filter syntax and field names.
  • Ensure API credentials are properly configured.
  • Use reasonable values for limit and offset.

Links and References

Discussion