AtomicBI icon

AtomicBI

Interact with Atomic BI API
Join our community

Actions16

Overview

This node interacts with the Atomic BI API to retrieve data about Campaigns. Specifically, the "Get" operation for the "Campaigns" resource allows users to query and fetch campaign records with flexible filtering, selection, ordering, and pagination options.

Common scenarios where this node is beneficial include:

  • Extracting specific campaign details for reporting or analytics.
  • Filtering campaigns based on custom criteria such as status, language, or creation date.
  • Paginating through large sets of campaigns to process them in batches.
  • Ordering campaigns by various fields like creation date or name.

For example, a user might want to get all active campaigns created after a certain date, selecting only their IDs and names, ordered by creation date descending, limited to 100 results.

Properties

Name Meaning
Select List of fields to select from each Campaign record. If left empty, all fields are selected. Available fields include Id, Name, Description, Language, Space Id, Agent Id, Status, Created At, Updated At, and others.
Filter Filters to apply to the Campaigns query. Each filter consists of a field (including a custom field option), an operator (Equals, Like, ILike, Contains), and a value. Multiple filters can be combined.
Offset Starting offset for the returned Campaigns, useful for pagination.
Limit Maximum number of Campaigns to return. The maximum allowed is 1000.
Order By Field by which to order the returned Campaigns. Options include Id, Name, Description, Language, Status, Created At, Updated At, and others.
Order Direction Direction of ordering: Ascending or Descending. This property is only applicable if "Order By" is set.
Additional Select Advanced option to specify additional select fields as a comma-separated string. These fields are appended to the main select list.

Output

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

If the "Limit" is set to 1, the output is wrapped as a single-item array containing one JSON object; otherwise, it returns an array of JSON objects, one per campaign.

No binary data output is produced by this node.

Example output JSON structure (fields depend on selection):

{
  "id": "123",
  "name": "Spring Sale Campaign",
  "status": "active",
  "createdAt": "2023-01-15T12:00:00Z"
}

Dependencies

  • Requires an API key credential for authenticating with the Atomic BI API.
  • Needs the base URL of the Atomic BI API endpoint.
  • No other external dependencies are required.
  • The node uses internal utility modules for building queries and parsing filters.

Troubleshooting

  • Invalid operation error: If an unsupported operation or resource is specified, the node throws an error indicating the invalid combination. Ensure that the resource is "campaigns" and the operation is "GET".
  • API authentication errors: If the API key or base URL credentials are missing or incorrect, the node will fail to connect. Verify that the correct API key credential is configured.
  • Filter syntax issues: Incorrectly formatted filters or unsupported operators may cause the API to reject the request. Use the provided filter options and ensure values match expected types.
  • Limit and offset misuse: Setting very high limits or offsets beyond available data may result in empty responses. Adjust these parameters according to dataset size.
  • Field selection errors: Selecting non-existent fields or malformed additional select strings may cause errors or incomplete data. Use only valid field names as listed.

Links and References

Discussion