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 Leads. Specifically, the "Get" operation for the "Leads" resource allows users to query and fetch lead records from Atomic BI with flexible options such as selecting specific fields, applying filters, pagination (offset and limit), and sorting.

Common scenarios where this node is beneficial include:

  • Extracting targeted lead information for marketing or sales automation workflows.
  • Filtering leads based on custom criteria to focus on relevant prospects.
  • Paginating through large lead datasets efficiently.
  • Sorting leads by various attributes like creation date or company name.

Practical example: A user wants to get a list of leads who work in a specific industry, only retrieving their first name, last name, email, and company name, sorted by the date they were created in descending order, limited to 100 results.

Properties

Name Meaning
Select List of lead fields to retrieve. If left empty, all fields are selected. Options include Campaign Id, Space Id, Stage, Status, Details, Messages, Created At, Updated At, Company Name, Email, Job Title, Skills, Website, etc.
Filter Filters to apply to the leads query. Multiple filters can be specified, each with a field (including custom fields), an operator (Equals, Like, ILike, Contains), and a value.
Offset Starting offset for the leads to return, useful for pagination.
Limit Maximum number of leads to return. The maximum allowed is 1000.
Order By Field by which to order the returned leads. Same options as Select fields.
Order Direction Direction of ordering: Ascending or Descending. Only applicable if "Order By" is set.
Additional Select Advanced option to specify additional select fields as a comma-separated string, appended to the main Select list.

Output

The output is an array of JSON objects representing the retrieved leads. Each object contains the fields requested via the Select and Additional Select properties. If the limit is set to 1, the output is wrapped differently to maintain consistency.

No binary data is output by this node.

Example output structure (simplified):

[
  {
    "json": {
      "id": "lead123",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "companyName": "Example Corp",
      "createdAt": "2023-01-01T12: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 indicated.

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 "leads" and operation is "GET".
  • Empty results: If no leads match the filter criteria, the output will be an empty array. Verify filter values and operators.
  • API authentication errors: If the API key or base URL credentials are incorrect or missing, the node will fail to connect. Check credential configuration.
  • Limit and offset misuse: Setting very high limits or offsets beyond available data may result in empty responses or performance issues. Use reasonable values.

Links and References

Discussion