Welcome to the ODBC Data Access service provided by Sight Machine. With this service, you can seamlessly connect to the Sight Machine platform and access your data using your API Key and Secret. This documentation guides you through the process of obtaining your credentials and connecting to the Sight Machine platform in various external products.
Obtaining Your API Key and Secret
Your API key and secret serve as your username and password for connecting to the Sight Machine database.
To obtain your API key and secret, do the following:
Go to your User Profile page, which you can access from the menu located in the top right.
Scroll down to the Security section. Do one of the following:
Click Create API Key to create a new API Key.
View an already existing API key and secret.
You can either copy your API key and secret from this page or generate a new set if needed.
Connecting with a Database Client
The Sight Machine database runs on PostgreSQL, so you need a database client with the appropriate drivers. Many clients use the JDBC driver, which you can find at https://jdbc.postgresql.org. Refer to your software's documentation for specific driver requirements. Your data is stored in the tenant_storage database within the sightmachine schema.
To connect, use the following information as required by your software:
Host: Your .sightmachine.io domain
Username: Your API key
Password: Your API secret
Connecting with PowerBI
To retrieve data from the Sight Machine database using PowerBI, do the following:
In the main ribbon menu, click Get Data, and then click More at the bottom of the menu.
In the resulting dialog box with data options, click the Database category on the left.
From the list on the right, click PostgreSQL database, and the click Connect.
On the next screen, type the server name. This should match your .sightmachine.io domain from the website. The database to connect to is tenant_storage.
Click either Import or DirectQuery, depending on your needs.
For your login credentials, type or paste your API key as the username and your API secret as the password.
Click Connect. Once you are connected, you can easily select your data for direct import or apply custom transformations as required.
You also have the option to view the native SQL query that is being executed, which can be helpful for debugging or gaining insights into your data.
Connecting with Mendix
To use your data in Mendix, do the following:
Download the PostgreSQL JDBC connector from https://jdbc.postgresql.org and place the .jar file in the userlib folder within your project folder.
Visit the Mendix Marketplace and download the Database Connector.
Insert the Database Connector into a microflow, as described in the Mendix documentation.
When configuring the action, provide the following values:
Jdbc url: jdbc:postgresql://your-company.sightmachine.io:5432/tenant_storage
User name: Your API key
Password: Your API secret
For more detailed information and assistance, refer to the full documentation available at https://docs.mendix.com/appstore/connectors/database-connector/.