How to Query PhantomBuster Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for PhantomBuster to query PhantomBuster data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live PhantomBuster data in MySQL Workbench.

Connect to PhantomBuster Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

Using API Key Authentication

To use the Phantombuster API, you need to obtain an API key from your Phantombuster account settings. Navigate to phantombuster.com, click your profile icon, select Settings, and copy the API key from the API section.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Phantombuster API key from the account settings page.

Multi-Organization Accounts

If your API key is associated with multiple organizations, you can target a specific organization by setting the OrganizationId connection property to the desired organization identifier. When set, it is sent as the X-Phantombuster-Org request header.

Example connection string:

Profile=C:\profiles\Phantombuster.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key_here"

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to PhantomBuster data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query PhantomBuster from MySQL Workbench

The steps below outline connecting to the virtual PhantomBuster database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live PhantomBuster data.

Connect to PhantomBuster through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for PhantomBuster).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query PhantomBuster Data

1. Open the connection you just created (CData SQL Gateway for PhantomBuster).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve PhantomBuster data, like SELECT * FROM `CData API Sys`.Agents;

With access to live PhantomBuster data from MySQL Workbench, you can easily work with PhantomBuster, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.