> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi.yaml post /api/v1/cdp/bi-connectors/{tool_id}/connection-profile
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/cdp/bi-connectors/{tool_id}/connection-profile:
    post:
      tags:
        - CDP
      summary: Generate a BI connection profile
      description: >-
        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.
      parameters:
        - schema:
            type: string
          in: path
          name: tool_id
          required: true
      responses:
        '200':
          description: >-
            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).
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                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'
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````