Data Sources API — Connect and Manage Data Sources

The Data Sources API lets you list and manage connected data sources programmatically. Use it to automate workspace provisioning, audit your connected integrations, or connect new databases and SaaS tools as part of your infrastructure-as-code workflow. Connecting and removing sources requires the admin scope; listing sources requires only the read scope.

GET /v1/data-sources — List Data Sources

Retrieve all data sources connected to your workspace.

Request example

cURL

curl https://api.canoanalytics.io/v1/data-sources \
  -H "Authorization: Bearer YOUR_API_KEY"

Response — 200 OK

200 OK

{
  "data": [
    {
      "id": "src_4mPk9rZyWc",
      "name": "Production Postgres",
      "type": "postgres",
      "status": "active",
      "last_synced_at": "2024-06-15T14:00:05Z"
    },
    {
      "id": "src_7bQn1xLdFh",
      "name": "Stripe Revenue",
      "type": "stripe",
      "status": "syncing",
      "last_synced_at": "2024-06-15T13:55:00Z"
    },
    {
      "id": "src_2jRw6vMaEt",
      "name": "Legacy BigQuery Export",
      "type": "bigquery",
      "status": "error",
      "last_synced_at": "2024-06-14T02:00:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

string

Unique identifier for the data source.

string

Human-readable name given to the data source when it was connected.

string

The data source type (e.g. postgres, mysql, bigquery, snowflake, stripe).

string

Current sync status. One of:

active — syncing normally
syncing — a sync is currently in progress
error — the last sync failed; check your credentials or network configuration
paused — syncing is manually paused

string

ISO 8601 timestamp of the most recently completed sync. null if the source has never synced successfully.

POST /v1/data-sources — Connect a Data Source

Connect a new data source to your Cano Analytics workspace. This endpoint requires the admin scope.

Never log, print, or expose the credentials object. It contains sensitive secrets such as database passwords and API keys. Treat it with the same care as your API key — store it in a secrets manager and transmit it only over HTTPS.

Body parameters

string

required

A descriptive name for this data source (e.g. "Production Postgres", "Stripe Live").

string

required

The type of data source to connect. Supported values include: postgres, mysql, bigquery, snowflake, redshift, stripe, salesforce, hubspot, segment

object

required

Connection credentials. The required fields depend on the type:

postgres / mysql / redshift: host, port, database, username, password
bigquery: project_id, dataset, service_account_key (JSON object)
snowflake: account, warehouse, database, username, password
stripe: api_key
salesforce / hubspot: access_token or OAuth credentials

object

Optional sync schedule. When omitted, Cano Analytics uses the default cadence for your plan.

frequency (string) — hourly, daily, or weekly
time (string) — preferred sync time in HH:MM UTC format (applies to daily and weekly)

Request example — connecting a PostgreSQL source

POST /v1/data-sources

{
  "name": "Production Postgres",
  "type": "postgres",
  "credentials": {
    "host": "db.example.com",
    "port": 5432,
    "database": "app_production",
    "username": "readonly_user",
    "password": "s3cr3t_p@ssword"
  },
  "schedule": {
    "frequency": "hourly"
  }
}

Response — 201 Created

201 Created

{
  "id": "src_4mPk9rZyWc",
  "name": "Production Postgres",
  "type": "postgres",
  "status": "testing",
  "created_at": "2024-06-15T15:30:00Z"
}

When a new source is created, its status is initially "testing" while Cano Analytics verifies the credentials and establishes a connection. The status transitions to active once the first sync completes successfully, or error if the connection check fails.

DELETE /v1/data-sources/ — Remove a Data Source

Disconnect and remove a data source from your workspace. This endpoint requires the admin scope.

Removing a data source does not delete historical data that has already been synced into Cano Analytics. Your previously synced tables, events, and reports derived from this source remain intact and queryable. Only future syncs are stopped.

Path parameters

string

required

The unique identifier of the data source to remove.

Request example

cURL

curl -X DELETE https://api.canoanalytics.io/v1/data-sources/src_4mPk9rZyWc \
  -H "Authorization: Bearer YOUR_ADMIN_API_KEY"

Response — 204 No Content

A successful deletion returns HTTP 204 with no response body.

Overview

Endpoints

SDKs

Data Sources API — Connect and Manage Data Sources

GET /v1/data-sources — List Data Sources

Request example

Response — 200 OK

POST /v1/data-sources — Connect a Data Source

Body parameters

Request example — connecting a PostgreSQL source

Response — 201 Created

DELETE /v1/data-sources/ — Remove a Data Source

Path parameters

Request example

Response — 204 No Content

​GET /v1/data-sources — List Data Sources

​Request example

​Response — 200 OK

​POST /v1/data-sources — Connect a Data Source

​Body parameters

​Request example — connecting a PostgreSQL source

​Response — 201 Created

​DELETE /v1/data-sources/ — Remove a Data Source

​Path parameters

​Request example

​Response — 204 No Content

GET /v1/data-sources — List Data Sources

Request example

Response — 200 OK

POST /v1/data-sources — Connect a Data Source

Body parameters

Request example — connecting a PostgreSQL source

Response — 201 Created

DELETE /v1/data-sources/ — Remove a Data Source

Path parameters

Request example

Response — 204 No Content