How to Visualize Gorgias Data in Python with pandas

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData API Driver for Python, the pandas & Matplotlib modules, and the SQLAlchemy toolkit, you can build Gorgias-connected Python applications and scripts for visualizing Gorgias data. This article shows how to use the pandas, SQLAlchemy, and Matplotlib built-in functions to connect to Gorgias data, execute queries, and visualize the results.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Gorgias data in Python. When you issue complex SQL queries from Gorgias, the driver pushes supported SQL operations, like filters and aggregations, directly to Gorgias and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Gorgias Data

Connecting to Gorgias data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

Start by setting the Profile connection property to the location of the Gorgias Profile on disk (e.g. C:\profiles\Gorgias.apip). Next, set the ProfileSettings connection property to the connection string for Gorgias (see below).

Gorgias API Profile Settings

Use your Gorgias login email as the User and your API key as the Password. Your Domain is the subdomain from your Gorgias portal URL.

Follow the procedure below to install the required modules and start accessing Gorgias through Python objects.

Install Required Modules

Use the pip utility to install the pandas & Matplotlib modules and the SQLAlchemy toolkit:

pip install pandas
pip install matplotlib
pip install sqlalchemy

Be sure to import the module with the following:

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engine

Visualize Gorgias Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Gorgias data.

engine = create_engine("api:///?Profile=C:\profiles\Gorgias.apip&ProfileSettings='User=your_email&Password=your_api_key&Domain=your_subdomain'")

Execute SQL to Gorgias

Use the read_sql function from pandas to execute any SQL statement and store the resultset in a DataFrame.

df = pandas.read_sql("SELECT Id, Name FROM Customers WHERE Active = 'true'", engine)

Visualize Gorgias Data

With the query results stored in a DataFrame, use the plot function to build a chart to display the Gorgias data. The show method displays the chart in a new window.

df.plot(kind="bar", x="Id", y="Name")
plt.show()

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to Gorgias data. Reach out to our Support Team if you have any questions.

Full Source Code

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engin

engine = create_engine("api:///?Profile=C:\profiles\Gorgias.apip&ProfileSettings='User=your_email&Password=your_api_key&Domain=your_subdomain'")
df = pandas.read_sql("SELECT Id, Name FROM Customers WHERE Active = 'true'", engine)

df.plot(kind="bar", x="Id", y="Name")
plt.show()