Actions8
Action → Get Leads
AI-generatedOverview
This node fetches lead data from a specified chatbot using the Chat Data API. It is useful for retrieving customer leads generated by chatbot interactions, with options to filter by date range and source, and to limit the number of results. For example, it can be used to gather leads created after a certain date or from a specific communication channel like WhatsApp or Slack.
Use Case Examples
- Retrieve up to 50 leads created after January 1, 2024, from a specific chatbot.
- Fetch leads from the Messenger source with a limit of 100 results.
Properties
| Name | Meaning |
|---|---|
| Chatbot Name or ID | The identifier of the chatbot from which to retrieve leads. This can be selected from a list or specified via an expression. |
| Limit | The maximum number of lead results to return from the API call. |
| Additional Fields | Optional filters to refine the leads retrieval, including start date, end date, and source of the leads. |
Output
JSON
json- Each item contains a single lead's data as returned by the Chat Data API.
Dependencies
- Requires an API key credential for the Chat Data API with a base URL and API key.
Troubleshooting
- Common errors include missing or invalid chatbot ID, invalid date formats, or API errors returned from the Chat Data service.
- If the API returns an error status, the node throws an error with the message from the API response.
- Ensure the API credentials are correctly configured with a valid base URL and API key.
- If the node is set to continue on fail, errors for individual items will be included in the output with an error property.