Leadiq

flowtask.components.LeadIQ

LeadIQ

LeadIQ(loop=None, job=None, stat=None, **kwargs)

Bases: FlowComponent, HTTPService

LeadIQ API Component

Overview:

This component interacts with the LeadIQ GraphQL API to retrieve company and employee information. Supports different types of searches through the 'type' parameter.

.. table:: Properties :widths: auto

+-----------------------+----------+------------------------------------------------------------------------------------------------------+ | Name | Required | Description | +-----------------------+----------+------------------------------------------------------------------------------------------------------+ | type | Yes | Type of search to perform: 'company', 'employees' or 'flat' | +-----------------------+----------+------------------------------------------------------------------------------------------------------+ | column | No | Name of the column containing company names (default: 'company_name') | +-----------------------+----------+------------------------------------------------------------------------------------------------------+ | companies | No | List of company names to search (alternative to using DataFrame input) | +-----------------------+----------+------------------------------------------------------------------------------------------------------+

Returns:

Type	Description
	DataFrame containing the requested information based on the search type

close async

close()

Clean up resources.

get_leadiq_url

get_leadiq_url(resource, args=None)

Construct LeadIQ API URL with optional query parameters.

run async

run()

Execute searches based on the specified type.

search_company async

search_company(company_name)

Basic company search.

search_employees async

search_employees(company_name)

Search for employees at a company.

search_flat async

search_flat(company_name)

Flat search for employees at a company.

start async

start(**kwargs)

Initialize the component and validate inputs.