How to Query Short.io Data in MySQL Workbench

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

Connect to Short.io 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

Short.io uses API Key authentication. To obtain your API key:

1. Log in to your Short.io account
2. Navigate to Settings > Integrations & API > API
3. Click Create API Key and copy your API key

After obtaining the API key, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Short.io API key obtained from Settings > Integrations & API > API.

Example connection string:

Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Available Tables

The Short.io profile provides access to the following tables:

• Domains - Short.io domains associated with the authenticated account
• Links - Short links for a domain
• LinkExpand - Expand a short link by domain and path
• LinksByOriginalUrl - Retrieve multiple short links matching a given original destination URL
• Folders - Link folders within a specific domain
• LinkPermissions - Permission records for a specific link within a domain
• CountryTargeting - Country-based redirect targeting rules for a specific short link
• RegionTargeting - Region-based redirect targeting rules for a specific short link
• Regions - List of available regions/states for a given country code
• DomainStatistics - Aggregated click and traffic statistics for a Short.io domain
• LinkStatistics - Aggregated click and traffic statistics for a specific Short.io link

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Short.io 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 Short.io from MySQL Workbench

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

Connect to Short.io through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Short.io).
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 Short.io Data

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

With access to live Short.io data from MySQL Workbench, you can easily work with Short.io, 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.