How to use SQLAlchemy ORM to access Gong Data in Python

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData API Driver for Python and the SQLAlchemy toolkit, you can build Gong-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to Gong data to query Gong data.

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

Connecting to Gong Data

Connecting to Gong 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.

To authenticate to Gong, you can use API Key authentication with your Gong API Key and API Secret.

Authentication

To authenticate to Gong, you must provide your Gong API Key and API Secret, along with your tenant Domain. These credentials are combined and Base64-encoded to form the Basic authentication header used for all API requests.

Using API Key Authentication

To authenticate using an API Key, you need to obtain your API Key and API Secret from your Gong account settings.

You can then connect by setting the AuthScheme to APIKey and providing your credentials:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Gong API Key.
• APISecret: Set this to your Gong API Secret.
• Domain: Set this to your Gong tenant domain (e.g., us-36533.api.gong.io).

Example connection string

Profile=C:\profiles\Gong.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your-tenant.api.gong.io';

Follow the procedure below to install SQLAlchemy and start accessing Gong through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit and SQLAlchemy ORM package:

pip install sqlalchemy
pip install sqlalchemy.orm

Be sure to import the appropriate modules:

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Model Gong Data in Python

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

NOTE: Users should URL encode the any connection string properties that include special characters. For more information, refer to the SQL Alchemy documentation.

engine = create_engine("api:///?Profile=C:\profiles\Gong.apip&AuthScheme=APIKey&ProfileSettings='APIKey=your_api_key&APISecret=your_api_secret&Domain=your-tenant.api.gong.io'")

Declare a Mapping Class for Gong Data

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the AnsweredScorecards table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base()
class AnsweredScorecards(base):
	__tablename__ = "AnsweredScorecards"
	 = Column(String,primary_key=True)
	 = Column(String)
	...

Query Gong Data

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("api:///?Profile=C:\profiles\Gong.apip&AuthScheme=APIKey&ProfileSettings='APIKey=your_api_key&APISecret=your_api_secret&Domain=your-tenant.api.gong.io'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(AnsweredScorecards).filter_by(=""):
	print(": ", instance.)
	print(": ", instance.)
	print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

AnsweredScorecards_table = AnsweredScorecards.metadata.tables["AnsweredScorecards"]
for instance in session.execute(AnsweredScorecards_table.select().where(AnsweredScorecards_table.c. == "")):
	print(": ", instance.)
	print(": ", instance.)
	print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

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 Gong data. Reach out to our Support Team if you have any questions.