Guide: Using REST API Integrations with Databox
IN THIS ARTICLE
This feature and other
Custom API Integrations are available on that are available on the Professional and Performer plans. Request a trial of Metric Builder by following
If you’d like to connect your Custom API Integrations using OAuth authentication, please book a call with one of our product experts to get a custom quote for a new integration.
How to connect your own REST API Data Source
IN THIS SECTION
How to connect a Custom REST API to Databox
How to Activate a Custom REST API
You can change the root API URL anytime later as well, but it will impact all created Custom metrics and could result in non-functional metrics because of invalid request URLs.
- None: makes API requests to a non-protected public API.
- Query parameters: requires you to define specific parameters to authenticate your requests.
- Headers: requires you to define specific parameters to authenticate your requests.
When selecting an authentication method, keep in mind that both Query parameters and Headers have the same structure (key, value) where you can define the necessary parameters to authenticate your requests.
You could also select None and add all necessary authentication parameters later on when building the Custom Metrics. This approach is not recommended because changing one authentication property in the future will require you to edit all custom metrics.
Pro Tip: If the API you are connecting supports standard Basic authentication, you should add custom authentication by setting the key of the query parameter to “Basic” and the value to “username:password” string encoded in base64.
Pro Tip: For Custom API Integrations using the OAuth authentication method, please book a call with one of our product experts to get a custom quote for a new integration.
How to create Custom Metrics
Once you have created the Custom Data Source connection, you can start creating Custom Metrics.
Learn more about how to create Custom Metrics, prepare API requests, and handle different use cases and limitations here.