Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe for free
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Contentstack for Developers
  • Agents Start Here
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Lytics API
  4. Connections

Connections

markdownView as Markdown

Create and manage connections to external data sources.

Get connections

GEThttps://api.lytics.io/v2/connection

Get a list of all connections for the account

Sample Response
Status|200 OK
1234567891011121314151617181920212223242526272829303132333435
{
  "_meta": {},
  "data": [
    {
      "account_id": "string",
      "aid": 0,
      "auth_ids": [
        "string"
      ],
      "author_id": "string",
      "config": {
        "bucket": "string",
        "connection_url": "string",
        "database": "string",
        "dataset": "string",
        "file": "string",
        "project": "string",
        "ssl_mode": "string"
      },
      "connection_config_id": "string",
      "connection_config_slug": "string",
      "created": "string",
      "deleted": "string",
      "description": "string",
      "id": "string",
      "label": "string",
      "provider_id": "string",
      "provider_slug": "string",
      "updated": "string",
      "updated_by_user_id": "string"
    }
  ],
  "request_id": "string",
  "status": 0
}

Create connection

POSThttps://api.lytics.io/v2/connection

Create a connection

Sample Request
1234567891011121314151617181920
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "bucket": "string",
    "connection_url": "string",
    "database": "string",
    "dataset": "string",
    "file": "string",
    "project": "string",
    "ssl_mode": "string"
  },
  "connection_config_id": "string",
  "connection_config_slug": "string",
  "description": "string",
  "label": "string",
  "provider_id": "string",
  "provider_slug": "string"
}
Sample Response
Status|201 Created
123456789101112131415161718192021222324252627282930313233
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "aid": 0,
    "auth_ids": [
      "string"
    ],
    "author_id": "string",
    "config": {
      "bucket": "string",
      "connection_url": "string",
      "database": "string",
      "dataset": "string",
      "file": "string",
      "project": "string",
      "ssl_mode": "string"
    },
    "connection_config_id": "string",
    "connection_config_slug": "string",
    "created": "string",
    "deleted": "string",
    "description": "string",
    "id": "string",
    "label": "string",
    "provider_id": "string",
    "provider_slug": "string",
    "updated": "string",
    "updated_by_user_id": "string"
  },
  "request_id": "string",
  "status": 0
}

Get connection

GEThttps://api.lytics.io/v2/connection/{id}

Get a connection by ID

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "aid": 0,
    "auth_ids": [
      "string"
    ],
    "author_id": "string",
    "config": {
      "bucket": "string",
      "connection_url": "string",
      "database": "string",
      "dataset": "string",
      "file": "string",
      "project": "string",
      "ssl_mode": "string"
    },
    "connection_config_id": "string",
    "connection_config_slug": "string",
    "created": "string",
    "deleted": "string",
    "description": "string",
    "id": "string",
    "label": "string",
    "provider_id": "string",
    "provider_slug": "string",
    "updated": "string",
    "updated_by_user_id": "string"
  },
  "request_id": "string",
  "status": 0
}

Update connection

PUThttps://api.lytics.io/v2/connection/{id}

Update a connection

Sample Request
1234567
{
  "auth_ids": [
    "string"
  ],
  "description": "string",
  "label": "string"
}
Sample Response
Status|201 Created
123456789101112131415161718192021222324252627282930313233
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "aid": 0,
    "auth_ids": [
      "string"
    ],
    "author_id": "string",
    "config": {
      "bucket": "string",
      "connection_url": "string",
      "database": "string",
      "dataset": "string",
      "file": "string",
      "project": "string",
      "ssl_mode": "string"
    },
    "connection_config_id": "string",
    "connection_config_slug": "string",
    "created": "string",
    "deleted": "string",
    "description": "string",
    "id": "string",
    "label": "string",
    "provider_id": "string",
    "provider_slug": "string",
    "updated": "string",
    "updated_by_user_id": "string"
  },
  "request_id": "string",
  "status": 0
}

Delete connection

DELETEhttps://api.lytics.io/v2/connection/{id}

Delete a connection

Sample Response
Status|201 Created
123456
{
  "_meta": {},
  "data": {},
  "request_id": "string",
  "status": 0
}

Count the rows a query returns

POSThttps://api.lytics.io/v2/connection/{id}/count

Count the rows a query against an external data source returns, without fetching them. The query is checked the same way as a scan; counting stops after a minute.

Sample Request
123
{
  "query": "string"
}
Sample Response
Status|200 OK
12345678
{
  "_meta": {},
  "data": {
    "row_count": 0
  },
  "request_id": "string",
  "status": 0
}

Query an external data source

POSThttps://api.lytics.io/v2/connection/{id}/scan

Query an external data source to get sample result set for members of a Cloud Connect model.

Sample Request
123456
{
  "primary_keys": [
    "string"
  ],
  "query": "string"
}
Sample Response
Status|200 OK
123456789101112131415
{
  "_meta": {},
  "data": {
    "columns": [
      {
        "column_datatype": "string",
        "column_name": "string"
      }
    ],
    "row_count": 0,
    "rows": null
  },
  "request_id": "string",
  "status": 0
}

Get the tables for a connection

GEThttps://api.lytics.io/v2/connection/{id}/schema

Returns all the table names for the given connection

Sample Response
Status|200 OK
12345678910111213
{
  "_meta": {},
  "data": [
    {
      "error": "string",
      "fully_qualified_name": "string",
      "num_columns": 0,
      "table_name": "string"
    }
  ],
  "request_id": "string",
  "status": 0
}

Get the schema for a table on the connection

GEThttps://api.lytics.io/v2/connection/{id}/schema/{table}

Returns all the columns for a table on the given connection

Sample Response
Status|200 OK
1234567891011
{
  "_meta": {},
  "data": [
    {
      "column_datatype": "string",
      "column_name": "string"
    }
  ],
  "request_id": "string",
  "status": 0
}
Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]
configoptionalobject
config.bucketoptionalstring
config.connection_urloptionalstring
config.databaseoptionalstring
config.datasetoptionalstring
config.fileoptionalstring
config.projectoptionalstring
config.ssl_modeoptionalstring
connection_config_idoptionalstring
connection_config_slugoptionalstring
descriptionoptionalstring
labeloptionalstring
provider_idoptionalstring
provider_slugoptionalstring
Hide Parameters

URL Parameters

idrequiredstring

The connection ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The connection ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]
descriptionoptionalstring
labeloptionalstring
Hide Parameters

URL Parameters

idrequiredstring

The connection ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The connection ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

queryoptionalstring
Hide Parameters

URL Parameters

idrequiredstring

The connection ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

limitoptionalstring

maximum num of rows to return per call, default = 20, max = 100

Headers

Authorizationoptionalstring

Body Parameters

primary_keysoptionalstring[]
queryoptionalstring
Hide Parameters

URL Parameters

idrequiredstring

The connection ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The connection ID

tablerequiredstring

The table name

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring