HeyQL

Documentation

Learn how to get the most out of HeyQL.

Getting Started

Welcome to HeyQL! Our goal is to make data analysis as simple as asking a question. Follow these steps to get started:

  1. Sign Up: Create your account to get started.
  2. Connect a Data Source: Navigate to the Connections page and add your first PostgreSQL, MySQL, Google Sheet, or CSV file.
  3. Start Asking: Go to the Chat interface, select your data source, and ask a question in natural language!
Connecting Data Sources

HeyQL supports multiple data source types. Here are some tips for connecting them:

PostgreSQL & MySQL

You can connect to your SQL databases using a standard connection URL. For security, we recommend creating a dedicated read-only user for HeyQL.

postgresql://user:password@host:port/dbname

Google Sheets

To connect a Google Sheet, simply paste its public URL. Make sure the sheet is shared with the service account email found in your environment variables.

CSV Files

You can upload a CSV file directly. The first row of your CSV will be used as the column headers.

Asking Questions

The power of HeyQL lies in its natural language interface. Here are some examples of questions you can ask:

  • "What were our total sales last month?"
  • "Show me the number of new users per week for the last 3 months."
  • "Which are the top 5 performing products by revenue?"
  • "Count of movies by rating"

Our AI will translate your question into a query, run it against your data source, and present the result as a chart, table, or text answer.

Collaboration & Dashboards

HeyQL is built for teams. You can easily share data sources and insights with your colleagues.

Inviting Members

Create an organization from the user menu in the top-right corner. Once you're in an organization's workspace, you can go to Organization Settings to invite members via email. An official invitation email will be sent, allowing them to sign up and join your team.

Sharing Dashboards

Any query result from the Chat interface can be pinned to a dashboard. Dashboards are specific to the workspace (Personal or Organization) they are created in. If you create a dashboard in an organization's workspace, all members of that organization will be able to view and interact with it.