AtomicBI icon

AtomicBI

Interact with Atomic BI API
Join our community

Actions16

Overview

This node interacts with the Atomic BI API to manage Campaigns data. Specifically, for the Delete operation on the Campaigns resource, it allows users to delete campaigns based on specified filters and criteria. This is useful in scenarios where you want to programmatically remove outdated or irrelevant campaign records from your Atomic BI database.

Practical examples include:

  • Automatically deleting campaigns that have been completed or inactive for a certain period.
  • Removing campaigns matching specific attributes such as status, language, or agent ID.
  • Cleaning up test or temporary campaigns after a marketing event.

Properties

Name Meaning
Select List of fields to select from the campaigns when performing the operation. If left empty, all fields are selected. Options include Id, Name, Description, Language, Space Id, Agent Id, Status, Created At, Updated At, etc.
Filter Filters to narrow down which campaigns to include. Each filter consists of: Field (e.g., Id, Name, Status), Operator (Equals, Like, ILike, Contains), and Value. Custom fields can also be specified.
Offset Starting offset for the list of campaigns to process. Useful for pagination or skipping initial records.
Limit Maximum number of campaigns to process. Limits the number of campaigns affected by the delete operation. Maximum allowed is 1000.
Order By Field by which to order the campaigns before processing. Same options as Select fields.
Order Direction Direction of ordering: Ascending or Descending.
Additional Select Advanced option to specify additional select fields as comma-separated values. Used to extend the fields retrieved beyond those in the Select property.

Output

The node outputs JSON data representing the campaigns affected by the operation. For the Delete operation, this typically includes details of the deleted campaigns or confirmation of deletion. The output structure contains an array of objects, each representing a campaign with the selected fields.

If binary data were involved (not indicated here), it would represent files or attachments related to campaigns, but this node focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating with the Atomic BI API.
  • Needs proper configuration of the Atomic BI API base URL.
  • The node depends on the Atomic BI API being accessible and responsive.

Troubleshooting

  • Invalid operation error: If an unsupported operation is requested, the node throws an error indicating the invalid resource/operation combination.
  • Authentication failures: Ensure the API key credential is valid and has sufficient permissions.
  • Filter syntax issues: Incorrectly formatted filters may cause the API to reject requests; verify field names, operators, and values.
  • Limit and offset misuse: Setting very high limits or incorrect offsets might lead to performance issues or unexpected results.
  • Network errors: Check connectivity to the Atomic BI API endpoint.

Links and References

Discussion