Uptick is an end-to-end job management platform and provides comprehensive out of the box reports you can use to track the performance of your business. At times, you may wish to develop bespoke reports specific to your business and mode of operation.
While our open API can be used to sync data to an external destination for this purpose, Uptick recommends the use of AirByte with the Uptick adapter to connect your Uptick workspace to the database/destination of your choosing. This will mitigate performance issues with your Uptick workspace and ensure that your connection is reliable and stable.
What is AirByte?
AirByte is an open source ETL tool with a built-in Uptick adapter and has a free tier. It allows you to sync your Uptick data to your own database for usage in BI reporting such as Power BI, Tableau or other reporting and integration purposes such as connecting to a CRM system such as Hubspot or Salesforce.
Can I connect directly from my BI tool?
Uptick does not allow its API to be used in direct connection with a BI solution, as BI solutions generally lack the sophistication to securely authenticate and paginate resources in an efficient way. When Uptick makes changes to its API, we also update the AirByte adapter which will generally mean less interruption to your third party tooling.
How do I get started with AirByte?
To get set up with AirByte, either ask your IT department to provision Airbyte within your infrastructure, or use AirByte Cloud. A basic configuration guide can be found below.
You can find out more information on AirByte using the following link: https://airbyte.com/
What items are available to sync?
To see all of the currently available streams, see this page on AirByte's help documentation.
How do I add additional streams?
If you need additional streams, please contact Uptick support ([email protected]) with a Professional Services request.
I am having difficulty using the Uptick adapter. How do I get help?
If you are experiencing issues with the Uptick adapter and require help, please contact Uptick support ([email protected]) with a Professional Services request.
Configuring the AirByte Uptick Adapter
In order to set up the Uptick adapter within AirByte, API credentials will need to be created in your Uptick workspace. Steps for creating an API client ID and secret can be found in the following support article:
In addition to the client ID and secret, a user account will need to be available with the appropriate permissions to access the required data streams.
Once AirByte has been set up and API credentials have been created, the adapter can be configured.
Navigate to your AirByte dashboard and click on New Connection
On the Define source step of the configuration, select Set up a new source, select Marketplace and search for Uptick. Click on the Uptick adapter.
Once you click on the Uptick adapter, you will need to fill in the connection details. These include:
The base URL of your Uptick workspace
The client ID and secret you created for connecting to the API
A refresh token
An access token
A start date
Note: The refresh token and access token for first time configuration can be generated using our Postman collection available at the support article linked above.
Once these details have been entered, click on Set up source. This will run an initial connection test. If the test passes, you will be able to proceed to selecting your destination. If the test fails, please re-check the connection details and try again.
Next, a destination needs to be selected - choose Set up a new destination. AirByte has a large number of adapters available for destinations. In this guide, Postgres will be used as an example but the general steps can be applied to your preferred destination.
Next, you will need to configure the connection details for your selected destination. Once these have been entered, select Set up destination.
Once the destination has been configured, you can select the streams you would like to sync from your Uptick workspace. The schema will show all of the currently available streams that can be synced. Select the checkboxes next to the streams you would like to sync. You can also use the dropdown shown beside each stream to choose the specific fields you would like to sync.
Once you have selected your streams, click on Next.
Next, configure the connection with the settings that best suit your requirements and then click Finish & Sync.
You should now be taken to your newly configured connection that will display the current status.