Generate a BI connection profile
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"tool_id": "tableau",
"status": "ga",
"connection_available": true,
"profile": {
"driver": "snowflake-jdbc",
"connection": {
"host": "orbit-warehouse.snowflakecomputing.com",
"warehouse": "ORBIT_WH",
"schema": "orbit_cdp"
},
"datasets": [
{
"key": "contacts",
"table": "orbit_cdp.contacts"
},
{
"key": "events",
"table": "orbit_cdp.events"
}
],
"setup_steps": [
"Create a read-only warehouse role scoped to the orbit_cdp schema.",
"Add a new Snowflake data source in Tableau using the host above."
]
}
},
"meta": {
"request_id": "req_01J8Z9K3P4Q5R6S7T8U9V0W1X2",
"timestamp": "2026-08-07T12:00:00.000Z"
}
}CDP
Generate a BI connection profile
Generates a per-tool, per-warehouse connection profile for a BI tool: the driver, connection fields, schema-qualified Orbit datasets, and the step-by-step setup an analyst follows to point the tool at their Orbit reverse-ETL warehouse. It does NOT persist anything, does NOT call the provider, and carries NO secrets — Orbit never proxies warehouse credentials. Returns 404 for an unknown tool and 400 for a warehouse / dataset / schema the chosen tool does not support. Owner / admin / developer only.
POST
/
api
/
v1
/
cdp
/
bi-connectors
/
{tool_id}
/
connection-profile
Generate a BI connection profile
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/cdp/bi-connectors/{tool_id}/connection-profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"tool_id": "tableau",
"status": "ga",
"connection_available": true,
"profile": {
"driver": "snowflake-jdbc",
"connection": {
"host": "orbit-warehouse.snowflakecomputing.com",
"warehouse": "ORBIT_WH",
"schema": "orbit_cdp"
},
"datasets": [
{
"key": "contacts",
"table": "orbit_cdp.contacts"
},
{
"key": "events",
"table": "orbit_cdp.events"
}
],
"setup_steps": [
"Create a read-only warehouse role scoped to the orbit_cdp schema.",
"Add a new Snowflake data source in Tableau using the host above."
]
}
},
"meta": {
"request_id": "req_01J8Z9K3P4Q5R6S7T8U9V0W1X2",
"timestamp": "2026-08-07T12:00:00.000Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Response
200 - application/json
The generated connection profile for the chosen tool + warehouse, with connection_available reflecting whether the tool is GA (a coming_soon tool still yields a profile for discovery).
The response is of type object.
⌘I